Scribd
Upload
2 views

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
Available Formats
Download as PDF, TXT or read online on Scribd
2 views

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
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
SearchAcross ........................................................................................................................ 3566
Suppressed ........................................................................................................................... 3566
ThicknessScaleFactor ............................................................................................................ 3566
ToleranceSlider ..................................................................................................................... 3566
ToleranceType ...................................................................................................................... 3567
ToleranceValue ..................................................................................................................... 3567
UseRange ............................................................................................................................. 3567
AddComment() ..................................................................................................................... 3567
AddContactRegion() ............................................................................................................. 3567
AddFigure() .......................................................................................................................... 3567
AddImage(string) .................................................................................................................. 3568
AddInterStage() .................................................................................................................... 3568
AddJoint() ............................................................................................................................. 3568
AddSpotWeld() ..................................................................................................................... 3568
CreateAutomaticConnections() ............................................................................................. 3568
Delete() ................................................................................................................................ 3569
DeleteChildren(bool) ............................................................................................................ 3569
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3569
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3569
RenameBasedOnChildren() ................................................................................................... 3570
RepairOverlappingContactRegions() ..................................................................................... 3570
SearchConnectionsForDuplicatePairs() .................................................................................. 3570
SetDefaultAPDLNames() ....................................................................................................... 3570
Connections ............................................................................................................................... 3571
Children ............................................................................................................................... 3572
Comments ............................................................................................................................ 3572
DataModelObjectCategory ................................................................................................... 3572
Figures ................................................................................................................................. 3573
FixedJoints ........................................................................................................................... 3573
GenerateAutomaticConnectionOnRefresh ............................................................................. 3573
Images ................................................................................................................................. 3573
InternalObject ...................................................................................................................... 3573
SolverFilesDirectory .............................................................................................................. 3573
TransparencyEnabled ............................................................................................................ 3574
AddAMBondConnection() ..................................................................................................... 3574
AddBeam() ........................................................................................................................... 3574
AddBearing() ........................................................................................................................ 3574
AddBodyInteraction() ............................................................................................................ 3574

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

AddComment() ..................................................................................................................... 3574


AddConnectionGroup() ......................................................................................................... 3575
AddContactRegion() ............................................................................................................. 3575
AddContactSolutionInformation() ......................................................................................... 3575
AddContactTool() .................................................................................................................. 3575
AddEndRelease() ................................................................................................................... 3575
AddFigure() .......................................................................................................................... 3575
AddImage(string) .................................................................................................................. 3576
AddInterStage() .................................................................................................................... 3576
AddJoint() ............................................................................................................................. 3576
AddSpotWeld() ..................................................................................................................... 3576
AddSpotWeldGroup() ........................................................................................................... 3576
AddSpring() .......................................................................................................................... 3577
CreateAutomaticConnections() ............................................................................................. 3577
ExportModelTopology(string) ............................................................................................... 3577
GenerateInitialContactResults() ............................................................................................. 3577
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3577
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3578
RepairOverlappingContactRegions() ..................................................................................... 3578
SearchConnectionsForDuplicatePairs() .................................................................................. 3578
ContactRegion ............................................................................................................................ 3579
AutomaticDetectionValue ..................................................................................................... 3582
AutomaticElectricCapacitance ............................................................................................... 3582
AutomaticElectricConductance ............................................................................................. 3583
AutomaticNormalStiffness ***OBSOLETE*** Use 'NormalStiffnessValueType' property in-
stead. ................................................................................................................................... 3583
AutomaticThermalConductance ............................................................................................ 3583
BeamBeamDetection ***OBSOLETE*** Use 'LineLineDetection' property instead. .................. 3583
BeamBeamModel ................................................................................................................. 3583
BeamMaterialName ***OBSOLETE*** Use 'Material' property instead. .................................... 3583
BeamRadius .......................................................................................................................... 3584
Behavior ............................................................................................................................... 3584
BondedMaximumOffset ........................................................................................................ 3584
Breakable ............................................................................................................................. 3584
Children ............................................................................................................................... 3584
Comments ............................................................................................................................ 3584
ConstraintType ..................................................................................................................... 3585
ContactAPDLName ............................................................................................................... 3585
ContactBodies ...................................................................................................................... 3585
ContactCenterPoint .............................................................................................................. 3585
ContactEndingPoint .............................................................................................................. 3585
ContactFormulation .............................................................................................................. 3585
ContactGeometryCorrection ................................................................................................. 3586
ContactOrientation ............................................................................................................... 3586
ContactShellFace .................................................................................................................. 3586
ContactStartingPoint ............................................................................................................ 3586
ContactType ......................................................................................................................... 3586
ContinuousDistanceComputation ......................................................................................... 3586
DataModelObjectCategory ................................................................................................... 3587
DecayConstant ..................................................................................................................... 3587
DetectionMethod ................................................................................................................. 3587

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

DisplayElementNormal ......................................................................................................... 3587


DynamicCoefficient .............................................................................................................. 3587
EdgeContactType ................................................................................................................. 3587
ElasticSlipTolerance .............................................................................................................. 3588
ElasticSlipToleranceFactor ..................................................................................................... 3588
ElasticSlipToleranceValue ...................................................................................................... 3588
ElectricCapacitanceValue ...................................................................................................... 3588
ElectricConductanceValue ..................................................................................................... 3588
Figures ................................................................................................................................. 3588
FlipContact ........................................................................................................................... 3589
FlipTarget ............................................................................................................................. 3589
FrictionCoefficient ................................................................................................................ 3589
Handedness ......................................................................................................................... 3589
Images ................................................................................................................................. 3589
InitialClearance ..................................................................................................................... 3589
InitialClearanceFactor ........................................................................................................... 3590
InitialClearanceValue ............................................................................................................. 3590
InterfaceTreatment ............................................................................................................... 3590
InternalObject ...................................................................................................................... 3590
LineLineDetection ................................................................................................................ 3590
Material ................................................................................................................................ 3590
MeanPitchDiameter .............................................................................................................. 3591
NormalForceExponent .......................................................................................................... 3591
NormalForceLimit ................................................................................................................. 3591
NormalStiffnessFactor ........................................................................................................... 3591
NormalStiffnessValue ............................................................................................................ 3591
NormalStiffnessValueType ..................................................................................................... 3591
NormalStressExponent ......................................................................................................... 3592
NormalStressLimit ................................................................................................................ 3592
PenetrationTolerance ............................................................................................................ 3592
PenetrationToleranceFactor .................................................................................................. 3592
PenetrationToleranceValue ................................................................................................... 3592
PinballFactor ......................................................................................................................... 3592
PinballRadius ........................................................................................................................ 3593
PinballRegion ....................................................................................................................... 3593
PitchDistance ........................................................................................................................ 3593
PressureAtZeroPenetration ................................................................................................... 3593
PressureAtZeroPenetrationFactor .......................................................................................... 3593
PressureAtZeroPenetrationValue ........................................................................................... 3593
Protected .............................................................................................................................. 3594
RBDContactDetection ........................................................................................................... 3594
RestitutionFactor .................................................................................................................. 3594
ScopeMode .......................................................................................................................... 3594
SharedSourceBody ............................................................................................................... 3594
SharedSourceReverseNormalLocation ................................................................................... 3594
SharedTargetBody ................................................................................................................ 3595
SharedTargetReverseNormalLocation .................................................................................... 3595
ShearForceExponent ............................................................................................................. 3595
ShearForceLimit .................................................................................................................... 3595
ShearStressExponent ............................................................................................................ 3595
ShearStressLimit ................................................................................................................... 3595

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

ShellThicknessEffect ............................................................................................................. 3596


SmallSliding .......................................................................................................................... 3596
SourceLocation ..................................................................................................................... 3596
StabilizationDampingFactor .................................................................................................. 3596
Suppressed ........................................................................................................................... 3596
TargetAPDLName ................................................................................................................. 3596
TargetBodies ......................................................................................................................... 3597
TargetCenterPoint ................................................................................................................. 3597
TargetEndingPoint ................................................................................................................ 3597
TargetGeometryCorrection ................................................................................................... 3597
TargetLocation ...................................................................................................................... 3597
TargetOrientation ................................................................................................................. 3597
TargetShellFace ..................................................................................................................... 3598
TargetStartingPoint ............................................................................................................... 3598
ThermalConductanceValue ................................................................................................... 3598
ThreadAngle ......................................................................................................................... 3598
ThreadType .......................................................................................................................... 3598
TimeStepControls ................................................................................................................. 3598
TrimContact .......................................................................................................................... 3599
TrimTolerance ....................................................................................................................... 3599
UpdateStiffness .................................................................................................................... 3599
UserOffset ............................................................................................................................ 3599
AddCommandSnippet() ........................................................................................................ 3599
AddComment() ..................................................................................................................... 3599
AddFigure() .......................................................................................................................... 3600
AddImage(string) .................................................................................................................. 3600
AddPythonCodeEventBased() ............................................................................................... 3600
Delete() ................................................................................................................................ 3600
FlipContactTarget() ............................................................................................................... 3600
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3601
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3601
LoadContactRegionSettings(string) ....................................................................................... 3601
PromoteToNamedSelection() ................................................................................................ 3602
PromoteToRemotePoint() ...................................................................................................... 3602
RenameBasedOnDefinition() ................................................................................................. 3602
ResetToDefault() ................................................................................................................... 3602
ResetToDefault(bool) ............................................................................................................ 3602
SaveContactRegionSettings(string) ....................................................................................... 3603
SearchConnectionsForDuplicatePairs() .................................................................................. 3603
SetDefaultAPDLNames() ....................................................................................................... 3603
ContactTool ................................................................................................................................ 3603
Children ............................................................................................................................... 3604
Comments ............................................................................................................................ 3604
DataModelObjectCategory ................................................................................................... 3605
Figures ................................................................................................................................. 3605
Images ................................................................................................................................. 3605
InternalObject ...................................................................................................................... 3605
Location ............................................................................................................................... 3605
ScopingMethod .................................................................................................................... 3605
AddComment() ..................................................................................................................... 3606
AddFigure() .......................................................................................................................... 3606

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

AddImage(string) .................................................................................................................. 3606


ClearGeneratedData() ........................................................................................................... 3606
Delete() ................................................................................................................................ 3606
EvaluateAllResults() ............................................................................................................... 3607
GenerateInitialContactResults() ............................................................................................. 3607
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3607
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3607
Joint ........................................................................................................................................... 3608
BushingWorksheet ................................................................................................................ 3611
Children ............................................................................................................................... 3611
Comments ............................................................................................................................ 3611
ConnectionType ................................................................................................................... 3611
CurveOrientationSurface ...................................................................................................... 3611
DataModelObjectCategory ................................................................................................... 3611
EffectiveLength ..................................................................................................................... 3612
ElementCoordinateSystem .................................................................................................... 3612
Figures ................................................................................................................................. 3612
Formulation .......................................................................................................................... 3612
FrictionCoefficient ................................................................................................................ 3612
GeneralPrimitiveType ............................................................................................................ 3612
Images ................................................................................................................................. 3613
InitialPosition ........................................................................................................................ 3613
InnerRadius .......................................................................................................................... 3613
InternalObject ...................................................................................................................... 3613
JointElementAPDLName ....................................................................................................... 3613
JointFrictionType .................................................................................................................. 3613
MobileAppliedBy .................................................................................................................. 3614
MobileBeamMaterial ............................................................................................................. 3614
MobileBeamRadius ............................................................................................................... 3614
MobileBehavior .................................................................................................................... 3614
MobileBody .......................................................................................................................... 3614
MobileCoordinateSystem ...................................................................................................... 3614
MobileFormulation ............................................................................................................... 3615
MobileLocation ..................................................................................................................... 3615
MobileNodeId ....................................................................................................................... 3615
MobilePinballRegion ............................................................................................................. 3615
MobileRelaxationMethod ...................................................................................................... 3615
OuterRadius ......................................................................................................................... 3615
RadialGapHeight .................................................................................................................. 3616
RadialGapInnerDiameter ....................................................................................................... 3616
RadialGapType ...................................................................................................................... 3616
RadialOuterDiameter ............................................................................................................ 3616
Radius .................................................................................................................................. 3616
ReferenceAppliedBy ............................................................................................................. 3616
ReferenceBeamMaterial ........................................................................................................ 3617
ReferenceBeamRadius .......................................................................................................... 3617
ReferenceBehavior ................................................................................................................ 3617
ReferenceBody ..................................................................................................................... 3617
ReferenceCoordinateSystem ................................................................................................. 3617
ReferenceFormulation ........................................................................................................... 3617
ReferenceLocation ................................................................................................................ 3618

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

ReferenceNodeId .................................................................................................................. 3618


ReferencePinballRegion ........................................................................................................ 3618
ReferenceRelaxationMethod ................................................................................................. 3618
RestitutionFactor .................................................................................................................. 3618
Rotations .............................................................................................................................. 3618
RXMaximum ......................................................................................................................... 3619
RXMaximumType .................................................................................................................. 3619
RXMinimum ......................................................................................................................... 3619
RXMinimumType .................................................................................................................. 3619
RYMaximum ......................................................................................................................... 3619
RYMaximumType .................................................................................................................. 3619
RYMinimum .......................................................................................................................... 3620
RYMinimumType .................................................................................................................. 3620
RZMaximum ......................................................................................................................... 3620
RZMaximumType .................................................................................................................. 3620
RZMinimum .......................................................................................................................... 3620
RZMinimumType .................................................................................................................. 3620
ScrewPitch ............................................................................................................................ 3621
SolverElementType ............................................................................................................... 3621
Suppressed ........................................................................................................................... 3621
SuppressedForSolve ............................................................................................................. 3621
TorsionalDamping ................................................................................................................ 3621
TorsionalStiffness .................................................................................................................. 3621
TranslationX .......................................................................................................................... 3622
TranslationY .......................................................................................................................... 3622
TranslationZ .......................................................................................................................... 3622
Type ..................................................................................................................................... 3622
XMaximum ........................................................................................................................... 3622
XMaximumType .................................................................................................................... 3622
XMinimum ........................................................................................................................... 3623
XMinimumType .................................................................................................................... 3623
YMaximum ........................................................................................................................... 3623
YMaximumType .................................................................................................................... 3623
YMinimum ............................................................................................................................ 3623
YMinimumType .................................................................................................................... 3623
ZMaximum ........................................................................................................................... 3624
ZMaximumType .................................................................................................................... 3624
ZMinimum ............................................................................................................................ 3624
ZMinimumType .................................................................................................................... 3624
AddCommandSnippet() ........................................................................................................ 3624
AddComment() ..................................................................................................................... 3624
AddFigure() .......................................................................................................................... 3625
AddImage(string) .................................................................................................................. 3625
Delete() ................................................................................................................................ 3625
FlipReferenceMobile() ........................................................................................................... 3625
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3625
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3626
PromoteToNamedSelection() ................................................................................................ 3626
PromoteToRemotePoint() ...................................................................................................... 3626
RenameBasedOnDefinition() ................................................................................................. 3627
SpotWeldConnection .................................................................................................................. 3627

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

AngleTolerance ..................................................................................................................... 3628


Children ............................................................................................................................... 3628
Comments ............................................................................................................................ 3628
ConnectionBehavior ............................................................................................................. 3628
DataModelObjectCategory ................................................................................................... 3628
Images ................................................................................................................................. 3629
InternalObject ...................................................................................................................... 3629
Material ................................................................................................................................ 3629
NumberOfLayers ................................................................................................................... 3629
NumWeldPoints .................................................................................................................... 3629
PenetrationTolerance ............................................................................................................ 3629
Radius .................................................................................................................................. 3630
SearchDistance ..................................................................................................................... 3630
ShellThicknessEffect ............................................................................................................. 3630
SnapToEdgeTolerance ........................................................................................................... 3630
SourceGeometry ................................................................................................................... 3630
StiffnessBehavior .................................................................................................................. 3630
TargetGeometry ................................................................................................................... 3631
Type ..................................................................................................................................... 3631
AddComment() ..................................................................................................................... 3631
AddImage(string) .................................................................................................................. 3631
AddNewSpotWeld(int) .......................................................................................................... 3631
CreateSpotWeldFromHitPoint() ............................................................................................. 3632
ExportToCSVFile(string) ......................................................................................................... 3632
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3632
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3633
RemoveSpotWeld(int) ........................................................................................................... 3633
SetXCoordinate(int, Quantity) ................................................................................................ 3633
SetYCoordinate(int, Quantity) ................................................................................................ 3634
SetZCoordinate(int, Quantity) ................................................................................................ 3634
SpotWeldGroup .......................................................................................................................... 3634
AngleTolerance ..................................................................................................................... 3636
Children ............................................................................................................................... 3636
ChildrenCreationMethod ...................................................................................................... 3636
Comments ............................................................................................................................ 3636
ConnectionBehavior ............................................................................................................. 3636
DataModelObjectCategory ................................................................................................... 3636
Images ................................................................................................................................. 3637
InternalObject ...................................................................................................................... 3637
Material ................................................................................................................................ 3637
NumberOfLayers ................................................................................................................... 3637
NumConnections .................................................................................................................. 3637
NumWeldPoints .................................................................................................................... 3637
PenetrationTolerance ............................................................................................................ 3638
ShellThicknessEffect ............................................................................................................. 3638
SnapToEdgeTolerance ........................................................................................................... 3638
SpotWeldFileName ............................................................................................................... 3638
StiffnessBehavior .................................................................................................................. 3638
Units .................................................................................................................................... 3638
WeldRadius .......................................................................................................................... 3639
WeldSearchDistance ............................................................................................................. 3639

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

WeldType ............................................................................................................................. 3639


AddComment() ..................................................................................................................... 3639
AddImage(string) .................................................................................................................. 3639
AddSpotWeldConnection() ................................................................................................... 3640
ExportToFile(string) ............................................................................................................... 3640
GenerateSpotWeldConnections() .......................................................................................... 3640
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3640
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3641
Spring ........................................................................................................................................ 3641
Children ............................................................................................................................... 3643
Comments ............................................................................................................................ 3643
DataModelObjectCategory ................................................................................................... 3643
Figures ................................................................................................................................. 3643
FreeLength ........................................................................................................................... 3644
Images ................................................................................................................................. 3644
InternalObject ...................................................................................................................... 3644
Load ..................................................................................................................................... 3644
LongitudinalDamping ........................................................................................................... 3644
LongitudinalStiffness ............................................................................................................ 3644
Material ................................................................................................................................ 3645
MobileAppliedBy .................................................................................................................. 3645
MobileBeamMaterial ............................................................................................................. 3645
MobileBeamRadius ............................................................................................................... 3645
MobileBehavior .................................................................................................................... 3645
MobileBody .......................................................................................................................... 3645
MobileCoordinateSystem ...................................................................................................... 3646
MobileLocation ..................................................................................................................... 3646
MobileNodeId ....................................................................................................................... 3646
MobilePinballRegion ............................................................................................................. 3646
MobileScopeLocation ........................................................................................................... 3646
MobileXCoordinate ............................................................................................................... 3646
MobileYCoordinate ............................................................................................................... 3647
MobileZCoordinate ............................................................................................................... 3647
NonLinearLongitudinalStiffness ............................................................................................ 3647
PreloadType ......................................................................................................................... 3647
ReferenceAppliedBy ............................................................................................................. 3647
ReferenceBeamMaterial ........................................................................................................ 3647
ReferenceBeamRadius .......................................................................................................... 3648
ReferenceBehavior ................................................................................................................ 3648
ReferenceBody ..................................................................................................................... 3648
ReferenceCoordinateSystem ................................................................................................. 3648
ReferenceLocation ................................................................................................................ 3648
ReferenceNodeId .................................................................................................................. 3648
ReferencePinballRegion ........................................................................................................ 3649
ReferenceScopeLocation ....................................................................................................... 3649
ReferenceXCoordinate .......................................................................................................... 3649
ReferenceYCoordinate .......................................................................................................... 3649
ReferenceZCoordinate .......................................................................................................... 3649
Rotation ............................................................................................................................... 3649
Scope ................................................................................................................................... 3650
SpringBehavior ..................................................................................................................... 3650

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

SpringElementAPDLName .................................................................................................... 3650


SpringLength ........................................................................................................................ 3650
SpringType ........................................................................................................................... 3650
Suppressed ........................................................................................................................... 3650
Torque .................................................................................................................................. 3651
TorsionalDamping ................................................................................................................ 3651
TorsionalStiffness .................................................................................................................. 3651
Visible .................................................................................................................................. 3651
AddCommandSnippet() ........................................................................................................ 3651
AddComment() ..................................................................................................................... 3651
AddFigure() .......................................................................................................................... 3652
AddImage(string) .................................................................................................................. 3652
Delete() ................................................................................................................................ 3652
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3652
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3653
PromoteToNamedSelection() ................................................................................................ 3653
PromoteToRemotePoint() ...................................................................................................... 3653
RenameBasedOnDefinition() ................................................................................................. 3653
Ansys.ACT.Automation.Mechanical.MaterialObject Namespace ................................................... 3655
MaterialModel ............................................................................................................................ 3655
Name ................................................................................................................................... 3655
Suppressed ........................................................................................................................... 3655
Ansys.ACT.Automation.Mechanical.CondensedParts Namespace ................................................ 3657
ExportSettings ............................................................................................................................ 3657
ExportSettings() .................................................................................................................... 3657
Ansys.ACT.Automation.Mechanical.BoundaryConditions Namespace ......................................... 3659
Acceleration ............................................................................................................................... 3662
AbsoluteResult ..................................................................................................................... 3663
BaseExcitation ...................................................................................................................... 3663
BoundaryCondition .............................................................................................................. 3664
Children ............................................................................................................................... 3664
Comments ............................................................................................................................ 3664
CoordinateSystem ................................................................................................................ 3664
DataModelObjectCategory ................................................................................................... 3664
DefineBy ............................................................................................................................... 3664
Direction .............................................................................................................................. 3665
Figures ................................................................................................................................. 3665
Images ................................................................................................................................. 3665
IndependentVariable ............................................................................................................ 3665
InternalObject ...................................................................................................................... 3665
LoadVectorAssignment ......................................................................................................... 3665
LoadVectorNumber .............................................................................................................. 3666
Location ............................................................................................................................... 3666
Magnitude ............................................................................................................................ 3666
MagnitudeImag .................................................................................................................... 3666
NumberOfSegments ............................................................................................................. 3666
PhaseAngle .......................................................................................................................... 3666
RpmSelection ....................................................................................................................... 3667
StepSelection ....................................................................................................................... 3667
StepVarying .......................................................................................................................... 3667
Suppressed ........................................................................................................................... 3667

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

XComponent ........................................................................................................................ 3667


YComponent ........................................................................................................................ 3667
ZComponent ........................................................................................................................ 3668
AddComment() ..................................................................................................................... 3668
AddFigure() .......................................................................................................................... 3668
AddImage(string) .................................................................................................................. 3668
Delete() ................................................................................................................................ 3668
GetActivateAtLoadStep(uint) ................................................................................................ 3669
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3669
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3669
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3670
AcousticAbsorptionElement ........................................................................................................ 3670
DataModelObjectCategory ................................................................................................... 3671
InternalObject ...................................................................................................................... 3671
Location ............................................................................................................................... 3671
AcousticAbsorptionSurface ......................................................................................................... 3671
AbsorptionCoefficient ........................................................................................................... 3672
DataModelObjectCategory ................................................................................................... 3672
InternalObject ...................................................................................................................... 3673
Location ............................................................................................................................... 3673
AcousticDiffuseSoundField ......................................................................................................... 3673
CoordinateSystem ................................................................................................................ 3674
DataModelObjectCategory ................................................................................................... 3674
FrequencyOfNormConvergenceCheck .................................................................................. 3675
InternalObject ...................................................................................................................... 3675
Location ............................................................................................................................... 3675
MassDensity ......................................................................................................................... 3675
Material ................................................................................................................................ 3675
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead ..................................... 3675
MaximumIncidentAngle ....................................................................................................... 3676
NormConvergenceTolerance ................................................................................................. 3676
NumberOfDivisionsOnReferenceSphere ................................................................................ 3676
NumberOfRandomSampling ................................................................................................. 3676
PressureExcitation ................................................................................................................. 3676
RadiusOfReferenceSphere ..................................................................................................... 3676
RadiusOfReferenceSphereDefineBy ....................................................................................... 3677
RandomSamplingType .......................................................................................................... 3677
ReferencePowerSpectralDensity ............................................................................................ 3677
SpeedOfSound ..................................................................................................................... 3677
AcousticFarFieldRadationSurface ................................................................................................ 3677
DataModelObjectCategory ................................................................................................... 3678
EquivalentSurfaceLocation .................................................................................................... 3678
InsideSurfaceBodiesLocation ................................................................................................ 3678
InternalObject ...................................................................................................................... 3679
AcousticFreeSurface ................................................................................................................... 3679
DataModelObjectCategory ................................................................................................... 3680
InternalObject ...................................................................................................................... 3680
Location ............................................................................................................................... 3680
AcousticImpedanceBoundary ..................................................................................................... 3680
DataModelObjectCategory ................................................................................................... 3681
Frequency ............................................................................................................................ 3681

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

InternalObject ...................................................................................................................... 3681


Location ............................................................................................................................... 3682
Reactance ............................................................................................................................. 3682
Resistance ............................................................................................................................ 3682
AcousticImpedanceSheet ........................................................................................................... 3682
DataModelObjectCategory ................................................................................................... 3683
InternalObject ...................................................................................................................... 3683
Location ............................................................................................................................... 3683
Reactance ............................................................................................................................. 3683
Resistance ............................................................................................................................ 3684
AcousticIncidentWaveSource ...................................................................................................... 3684
AnglePhi ............................................................................................................................... 3685
AngleTheta ........................................................................................................................... 3685
CalculateIncidentPower ........................................................................................................ 3686
DataModelObjectCategory ................................................................................................... 3686
DipoleLength ....................................................................................................................... 3686
ExcitationType ...................................................................................................................... 3686
IncidentWaveLocation .......................................................................................................... 3686
InternalObject ...................................................................................................................... 3686
MassDensity ......................................................................................................................... 3687
Material ................................................................................................................................ 3687
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead ..................................... 3687
PhaseAngle .......................................................................................................................... 3687
PortSelection ........................................................................................................................ 3687
PressureAmplitude ............................................................................................................... 3687
RadiusOfPulsatingSphere ...................................................................................................... 3688
SourceOriginX ...................................................................................................................... 3688
SourceOriginY ...................................................................................................................... 3688
SourceOriginZ ...................................................................................................................... 3688
SpeedOfSound ..................................................................................................................... 3688
VelocityAmplitude ................................................................................................................ 3688
WaveNumber ........................................................................................................................ 3689
WaveType ............................................................................................................................. 3689
XComponentOfUnitDipoleVector .......................................................................................... 3689
YComponentOfUnitDipoleVector .......................................................................................... 3689
ZComponentOfUnitDipoleVector .......................................................................................... 3689
AcousticLowReducedFrequency .................................................................................................. 3689
DataModelObjectCategory ................................................................................................... 3690
HeightOfRectangle ............................................................................................................... 3691
InternalObject ...................................................................................................................... 3691
Location ............................................................................................................................... 3691
LowReducedFrequencyModel ............................................................................................... 3691
RadiusOfCircle ...................................................................................................................... 3691
ThicknessOfLayer .................................................................................................................. 3691
WidthOfRectangle ................................................................................................................ 3692
AcousticMassSource ................................................................................................................... 3692
DataModelObjectCategory ................................................................................................... 3693
InternalObject ...................................................................................................................... 3693
Location ............................................................................................................................... 3693
Magnitude ............................................................................................................................ 3693
PhaseAngle .......................................................................................................................... 3693

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

AcousticMassSourceRate ............................................................................................................ 3693


DataModelObjectCategory ................................................................................................... 3694
InternalObject ...................................................................................................................... 3695
Location ............................................................................................................................... 3695
Magnitude ............................................................................................................................ 3695
AcousticPort ............................................................................................................................... 3695
DataModelObjectCategory ................................................................................................... 3696
InsideSurfaceBodiesLocation ................................................................................................ 3696
InternalObject ...................................................................................................................... 3696
PortBehavior ......................................................................................................................... 3696
PortNumber ......................................................................................................................... 3697
PortPosition .......................................................................................................................... 3697
PortSurfaceLocation ............................................................................................................. 3697
AcousticPortInDuct ..................................................................................................................... 3697
AnglePhi ............................................................................................................................... 3698
AngleTheta ........................................................................................................................... 3699
CoordinateSystem ................................................................................................................ 3699
DataModelObjectCategory ................................................................................................... 3699
Height .................................................................................................................................. 3699
InternalObject ...................................................................................................................... 3699
Location ............................................................................................................................... 3699
ModeIndexForPressureVariationAlongTheAzimuth ................................................................ 3700
ModeIndexForPressureVariationAlongTheHeight .................................................................. 3700
ModeIndexForPressureVariationAlongTheRadii ..................................................................... 3700
ModeIndexForPressureVariationAlongTheWidth .................................................................... 3700
PhaseAngle .......................................................................................................................... 3700
PortAttribution ..................................................................................................................... 3700
PortSelection ........................................................................................................................ 3701
PressureAmplitude ............................................................................................................... 3701
Radius .................................................................................................................................. 3701
WaveType ............................................................................................................................. 3701
Width ................................................................................................................................... 3701
AcousticPressure ......................................................................................................................... 3701
DataModelObjectCategory ................................................................................................... 3702
InternalObject ...................................................................................................................... 3702
Location ............................................................................................................................... 3703
Magnitude ............................................................................................................................ 3703
AcousticRadiationBoundary ........................................................................................................ 3703
DataModelObjectCategory ................................................................................................... 3704
InternalObject ...................................................................................................................... 3704
Location ............................................................................................................................... 3704
AcousticRigidWall ....................................................................................................................... 3704
DataModelObjectCategory ................................................................................................... 3705
InternalObject ...................................................................................................................... 3705
Location ............................................................................................................................... 3705
AcousticStaticPressure ................................................................................................................ 3706
DataModelObjectCategory ................................................................................................... 3706
InternalObject ...................................................................................................................... 3707
Location ............................................................................................................................... 3707
Magnitude ............................................................................................................................ 3707
AcousticSurfaceAcceleration ....................................................................................................... 3707

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

DataModelObjectCategory ................................................................................................... 3708


DefineBy ............................................................................................................................... 3708
InternalObject ...................................................................................................................... 3708
Location ............................................................................................................................... 3709
Magnitude ............................................................................................................................ 3709
XComponent ........................................................................................................................ 3709
YComponent ........................................................................................................................ 3709
ZComponent ........................................................................................................................ 3709
AcousticSurfaceVelocity .............................................................................................................. 3709
DataModelObjectCategory ................................................................................................... 3710
DefineBy ............................................................................................................................... 3711
InternalObject ...................................................................................................................... 3711
Location ............................................................................................................................... 3711
Magnitude ............................................................................................................................ 3711
PhaseAngle .......................................................................................................................... 3711
XComponent ........................................................................................................................ 3711
XPhaseAngle ........................................................................................................................ 3712
YComponent ........................................................................................................................ 3712
YPhaseAngle ........................................................................................................................ 3712
ZComponent ........................................................................................................................ 3712
ZPhaseAngle ........................................................................................................................ 3712
AcousticSymmetryPlane ............................................................................................................. 3712
CoordinateSystem ................................................................................................................ 3713
DataModelObjectCategory ................................................................................................... 3713
InternalObject ...................................................................................................................... 3714
Location ............................................................................................................................... 3714
AcousticTemperature .................................................................................................................. 3714
DataModelObjectCategory ................................................................................................... 3716
InternalObject ...................................................................................................................... 3716
AcousticThermoViscousBLIBoundary .......................................................................................... 3716
DataModelObjectCategory ................................................................................................... 3717
InternalObject ...................................................................................................................... 3717
Location ............................................................................................................................... 3717
AcousticTransferAdmittanceMatrix .............................................................................................. 3717
Alpha1Imag .......................................................................................................................... 3719
Alpha1Real ........................................................................................................................... 3719
Alpha2Imag .......................................................................................................................... 3719
Alpha2Real ........................................................................................................................... 3719
DataModelObjectCategory ................................................................................................... 3719
DynamicViscosity ................................................................................................................. 3719
GridPeriod ............................................................................................................................ 3720
HoleRadius ........................................................................................................................... 3720
InternalObject ...................................................................................................................... 3720
MassDensity ......................................................................................................................... 3720
Port1 .................................................................................................................................... 3720
Port2 .................................................................................................................................... 3720
RatioOfInnerAndOuterRadius ................................................................................................ 3721
StructureThickness ............................................................................................................... 3721
TransferAdmittanceModel ..................................................................................................... 3721
Y11Imag ............................................................................................................................... 3721
Y11Real ................................................................................................................................ 3721

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

Y12Imag ............................................................................................................................... 3721


Y12Real ................................................................................................................................ 3722
Y21Imag ............................................................................................................................... 3722
Y21Real ................................................................................................................................ 3722
Y22Imag ............................................................................................................................... 3722
Y22Real ................................................................................................................................ 3722
BearingLoad ............................................................................................................................... 3722
CoordinateSystem ................................................................................................................ 3724
DataModelObjectCategory ................................................................................................... 3724
DefineBy ............................................................................................................................... 3724
Direction .............................................................................................................................. 3724
InternalObject ...................................................................................................................... 3724
Location ............................................................................................................................... 3724
Magnitude ............................................................................................................................ 3725
XComponent ........................................................................................................................ 3725
YComponent ........................................................................................................................ 3725
ZComponent ........................................................................................................................ 3725
GetActivateAtLoadStep(uint) ................................................................................................ 3725
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3726
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3726
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3726
BodyControl ............................................................................................................................... 3727
ArtificialViscosityForShells ..................................................................................................... 3728
BeamSolutionType ................................................................................................................ 3728
BeamTimeStepSafetyFactor .................................................................................................. 3728
DataModelObjectCategory ................................................................................................... 3728
HexIntegrationType .............................................................................................................. 3729
HourglassDampingType ........................................................................................................ 3729
InternalObject ...................................................................................................................... 3729
Location ............................................................................................................................... 3729
PusoStabilityCoefficient ........................................................................................................ 3729
ShellBWCWarpCorrection ...................................................................................................... 3729
ShellInertiaUpdate ................................................................................................................ 3730
ShellShearCorrectionFactor ................................................................................................... 3730
ShellSublayers ...................................................................................................................... 3730
ShellThicknessUpdate ........................................................................................................... 3730
StiffnessCoefficient ............................................................................................................... 3730
TetIntegrationType ............................................................................................................... 3730
ViscousCoefficient ................................................................................................................ 3731
BoltPretension ............................................................................................................................ 3731
Children ............................................................................................................................... 3732
Comments ............................................................................................................................ 3732
CoordinateSystem ................................................................................................................ 3732
CoordinateSystemBehavior ................................................................................................... 3733
DataModelObjectCategory ................................................................................................... 3733
DefineBy ***OBSOLETE*** Use GetDefineBy(int stepNumber) and SetDefineBy(int stepNumber,
BoltLoadDefineBy type) to have an access to the whole series of values over the course of simu-
lation and not only the value for the current step. .................................................................. 3733
Figures ................................................................................................................................. 3733
Formulation .......................................................................................................................... 3733
Images ................................................................................................................................. 3733

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

Increment ............................................................................................................................. 3734


InternalObject ...................................................................................................................... 3734
Location ............................................................................................................................... 3734
Preadjustment ...................................................................................................................... 3734
Preload ................................................................................................................................. 3734
SolveBehaviourType ............................................................................................................. 3734
Suppressed ........................................................................................................................... 3735
Tolerance .............................................................................................................................. 3735
AddComment() ..................................................................................................................... 3735
AddFigure() .......................................................................................................................... 3735
AddImage(string) .................................................................................................................. 3735
Delete() ................................................................................................................................ 3736
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3736
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3736
GetDefineBy(int) ................................................................................................................... 3737
PromoteToCoordinateSystem() .............................................................................................. 3737
PromoteToNamedSelection() ................................................................................................ 3737
SetDefineBy(int, BoltLoadDefineBy) ....................................................................................... 3737
CompressionOnlySupport ........................................................................................................... 3738
AutomaticNormalStiffness .................................................................................................... 3739
DataModelObjectCategory ................................................................................................... 3739
InternalObject ...................................................................................................................... 3739
Location ............................................................................................................................... 3739
NormalStiffnessFactor ........................................................................................................... 3739
UpdateStiffness .................................................................................................................... 3739
ConstraintEquation ..................................................................................................................... 3740
Children ............................................................................................................................... 3740
Comments ............................................................................................................................ 3740
DataModelObjectCategory ................................................................................................... 3741
Figures ................................................................................................................................. 3741
InternalObject ...................................................................................................................... 3741
Suppressed ........................................................................................................................... 3741
AddCommandSnippet() ........................................................................................................ 3741
AddComment() ..................................................................................................................... 3741
AddFigure() .......................................................................................................................... 3742
Delete() ................................................................................................................................ 3742
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3742
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3742
ContactStepControl .................................................................................................................... 3743
ContactSelection .................................................................................................................. 3744
CurrentStep .......................................................................................................................... 3744
DataModelObjectCategory ................................................................................................... 3744
InternalObject ...................................................................................................................... 3744
NormalStiffness .................................................................................................................... 3744
NormalStiffnessFactor ........................................................................................................... 3744
NormalStiffnessValue ............................................................................................................ 3745
Status ................................................................................................................................... 3745
Convection ................................................................................................................................. 3745
AmbientTemperature ............................................................................................................ 3747
AmbientTemperatureCoordinateSystem ............................................................................... 3747
CoefficientType ..................................................................................................................... 3747

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

ConvectionCoefficientCoordinateSystem .............................................................................. 3748


ConvectionMatrix ................................................................................................................. 3748
DataModelObjectCategory ................................................................................................... 3748
DisplayConnectionLines ........................................................................................................ 3748
EditDataFor .......................................................................................................................... 3748
ElementAPDLName .............................................................................................................. 3748
FilmCoefficient ..................................................................................................................... 3749
FluidFlowSelection ............................................................................................................... 3749
GraphControlsXAxis .............................................................................................................. 3749
HasFluidFlow ........................................................................................................................ 3749
IndependentVariable ............................................................................................................ 3749
InternalObject ...................................................................................................................... 3750
Location ............................................................................................................................... 3750
NumberOfSegments ............................................................................................................. 3750
RangeMaximum ................................................................................................................... 3750
RangeMinimum .................................................................................................................... 3750
XYZFunctionCoordinateSystem ............................................................................................. 3750
GetActivateAtLoadStep(uint) ................................................................................................ 3751
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3751
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3751
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3752
CoupledPhysicsHeatingObjects ................................................................................................... 3752
Children ............................................................................................................................... 3753
Comments ............................................................................................................................ 3753
DataModelObjectCategory ................................................................................................... 3753
Images ................................................................................................................................. 3753
InternalObject ...................................................................................................................... 3753
Location ............................................................................................................................... 3754
Suppressed ........................................................................................................................... 3754
AddComment() ..................................................................................................................... 3754
AddImage(string) .................................................................................................................. 3754
Delete() ................................................................................................................................ 3754
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3755
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3755
Coupling .................................................................................................................................... 3755
Children ............................................................................................................................... 3756
Comments ............................................................................................................................ 3756
DataModelObjectCategory ................................................................................................... 3756
DOFSelection ....................................................................................................................... 3757
Images ................................................................................................................................. 3757
InternalObject ...................................................................................................................... 3757
LocalCoordinates .................................................................................................................. 3757
Location ............................................................................................................................... 3757
Suppressed ........................................................................................................................... 3757
AddComment() ..................................................................................................................... 3758
AddImage(string) .................................................................................................................. 3758
Delete() ................................................................................................................................ 3758
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3758
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3759
Current ....................................................................................................................................... 3759
DataModelObjectCategory ................................................................................................... 3760

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

InternalObject ...................................................................................................................... 3760


Location ............................................................................................................................... 3760
Magnitude ............................................................................................................................ 3760
NumberOfSegments ............................................................................................................. 3761
PhaseAngle .......................................................................................................................... 3761
GetActivateAtLoadStep(uint) ................................................................................................ 3761
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3761
CylindricalSupport ...................................................................................................................... 3762
Axial ..................................................................................................................................... 3763
DataModelObjectCategory ................................................................................................... 3763
InternalObject ...................................................................................................................... 3763
Location ............................................................................................................................... 3763
Radial ................................................................................................................................... 3763
Tangential ............................................................................................................................ 3763
DetonationPoint ......................................................................................................................... 3764
BurnInstantaneously ............................................................................................................. 3764
DataModelObjectCategory ................................................................................................... 3765
DetonationTime ................................................................................................................... 3765
InternalObject ...................................................................................................................... 3765
Location ............................................................................................................................... 3765
XCoordinate ......................................................................................................................... 3765
YCoordinate .......................................................................................................................... 3765
ZCoordinate ......................................................................................................................... 3766
Displacement ............................................................................................................................. 3766
AbsoluteResult ..................................................................................................................... 3768
BaseExcitation ...................................................................................................................... 3768
BoundaryCondition .............................................................................................................. 3768
CoordinateSystem ................................................................................................................ 3768
DataModelObjectCategory ................................................................................................... 3768
DefineBy ............................................................................................................................... 3768
Direction .............................................................................................................................. 3769
Distance ............................................................................................................................... 3769
DynamicRelaxationBehavior ................................................................................................. 3769
GraphControlsXAxis .............................................................................................................. 3769
IndependentVariable ............................................................................................................ 3769
InternalObject ...................................................................................................................... 3769
Location ............................................................................................................................... 3770
MagnitudeImag .................................................................................................................... 3770
NumberOfSegments ............................................................................................................. 3770
PhaseAngle .......................................................................................................................... 3770
RangeMaximum ................................................................................................................... 3770
RangeMinimum .................................................................................................................... 3770
ReverseDirectionForInverseSteps .......................................................................................... 3771
RpmSelection ....................................................................................................................... 3771
StepSelection ....................................................................................................................... 3771
StepVarying .......................................................................................................................... 3771
XComponent ........................................................................................................................ 3771
XComponentImag ................................................................................................................ 3771
XPhaseAngle ........................................................................................................................ 3772
XYZFunctionCoordinateSystem ............................................................................................. 3772
YComponent ........................................................................................................................ 3772

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

YComponentImag ................................................................................................................ 3772


YPhaseAngle ........................................................................................................................ 3772
ZComponent ........................................................................................................................ 3772
ZComponentImag ................................................................................................................ 3773
ZPhaseAngle ........................................................................................................................ 3773
GetActivateAtLoadStep(uint) ................................................................................................ 3773
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3773
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3774
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3774
EarthGravity ............................................................................................................................... 3774
Children ............................................................................................................................... 3775
Comments ............................................................................................................................ 3775
CoordinateSystem ................................................................................................................ 3776
DataModelObjectCategory ................................................................................................... 3776
Direction .............................................................................................................................. 3776
Figures ................................................................................................................................. 3776
GeometrySelection ............................................................................................................... 3776
Images ................................................................................................................................. 3776
InternalObject ...................................................................................................................... 3777
Suppressed ........................................................................................................................... 3777
XComponent ........................................................................................................................ 3777
YComponent ........................................................................................................................ 3777
ZComponent ........................................................................................................................ 3777
AddComment() ..................................................................................................................... 3777
AddFigure() .......................................................................................................................... 3778
AddImage(string) .................................................................................................................. 3778
Delete() ................................................................................................................................ 3778
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3778
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3779
ElasticSupport ............................................................................................................................ 3779
DataModelObjectCategory ................................................................................................... 3780
FoundationStiffness .............................................................................................................. 3780
InternalObject ...................................................................................................................... 3780
Location ............................................................................................................................... 3780
ElectricCharge ............................................................................................................................ 3781
DataModelObjectCategory ................................................................................................... 3781
InternalObject ...................................................................................................................... 3782
Location ............................................................................................................................... 3782
Magnitude ............................................................................................................................ 3782
VoltageCoupling ................................................................................................................... 3782
ElementBirthAndDeath ............................................................................................................... 3782
CurrentStep .......................................................................................................................... 3783
DataModelObjectCategory ................................................................................................... 3783
InternalObject ...................................................................................................................... 3783
Location ............................................................................................................................... 3784
Status ................................................................................................................................... 3784
ElementControls ......................................................................................................................... 3784
Children ............................................................................................................................... 3785
Comments ............................................................................................................................ 3785
DataModelObjectCategory ................................................................................................... 3785
Figures ................................................................................................................................. 3785

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

Images ................................................................................................................................. 3785


InternalObject ...................................................................................................................... 3785
Suppressed ........................................................................................................................... 3786
AddComment() ..................................................................................................................... 3786
AddFigure() .......................................................................................................................... 3786
AddImage(string) .................................................................................................................. 3786
Delete() ................................................................................................................................ 3786
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3787
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3787
EMTransducer ............................................................................................................................. 3787
CoordinateSystem ................................................................................................................ 3789
DataModelObjectCategory ................................................................................................... 3789
GAPDirection ........................................................................................................................ 3789
IndependentVariable ............................................................................................................ 3789
InitialGap .............................................................................................................................. 3789
InternalObject ...................................................................................................................... 3790
Location ............................................................................................................................... 3790
MinimalGap .......................................................................................................................... 3790
NumberOfSegments ............................................................................................................. 3790
StiffnessMethod ................................................................................................................... 3790
VoltageDifference ................................................................................................................. 3790
ZCoordinate ......................................................................................................................... 3791
GetActivateAtLoadStep(uint) ................................................................................................ 3791
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3791
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3791
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3792
FixedRotation ............................................................................................................................. 3792
CoordinateSystem ................................................................................................................ 3793
DataModelObjectCategory ................................................................................................... 3793
InternalObject ...................................................................................................................... 3793
Location ............................................................................................................................... 3794
RotationX ............................................................................................................................. 3794
RotationY ............................................................................................................................. 3794
RotationZ ............................................................................................................................. 3794
FixedSupport .............................................................................................................................. 3794
DataModelObjectCategory ................................................................................................... 3795
InternalObject ...................................................................................................................... 3795
Location ............................................................................................................................... 3795
FluidPenetrationPressure ............................................................................................................ 3796
ContactRegionSelection ....................................................................................................... 3797
DataModelObjectCategory ................................................................................................... 3797
GraphControlsXAxis .............................................................................................................. 3797
GraphDisplaySelection .......................................................................................................... 3797
IndependentVariable ............................................................................................................ 3798
InternalObject ...................................................................................................................... 3798
Magnitude ............................................................................................................................ 3798
NumberOfSegments ............................................................................................................. 3798
PenetrationCriterion ............................................................................................................. 3798
PenetrationCriterionDefinedBy ............................................................................................. 3798
PenetrationPathType ............................................................................................................ 3799
StartPointLocation ................................................................................................................ 3799

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

StartPointScopingType ......................................................................................................... 3799


UpdatePressureType ............................................................................................................. 3799
XYZFunctionCoordinateSystem ............................................................................................. 3799
GetActivateAtLoadStep(uint) ................................................................................................ 3800
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3800
FluidSolidInterface ...................................................................................................................... 3800
DataModelObjectCategory ................................................................................................... 3801
ExportResults ....................................................................................................................... 3801
InterfaceNumber .................................................................................................................. 3801
InternalObject ...................................................................................................................... 3802
Location ............................................................................................................................... 3802
Force .......................................................................................................................................... 3802
AppliedBy ............................................................................................................................. 3804
CoordinateSystem ................................................................................................................ 3804
DataModelObjectCategory ................................................................................................... 3804
DefineBy ............................................................................................................................... 3804
Direction .............................................................................................................................. 3804
DivideLoadByNodes .............................................................................................................. 3805
DynamicRelaxationBehavior ................................................................................................. 3805
GraphControlsXAxis .............................................................................................................. 3805
HarmonicIndex ..................................................................................................................... 3805
IndependentVariable ............................................................................................................ 3805
InternalObject ...................................................................................................................... 3805
LoadVectorAssignment ......................................................................................................... 3806
LoadVectorNumber .............................................................................................................. 3806
Location ............................................................................................................................... 3806
Magnitude ............................................................................................................................ 3806
MagnitudeImag .................................................................................................................... 3806
NonCyclicLoadingType ......................................................................................................... 3806
NumberOfSegments ............................................................................................................. 3807
PhaseAngle .......................................................................................................................... 3807
RangeMaximum ................................................................................................................... 3807
RangeMinimum .................................................................................................................... 3807
RpmSelection ....................................................................................................................... 3807
SectorNumber ...................................................................................................................... 3807
StepSelection ....................................................................................................................... 3808
StepVarying .......................................................................................................................... 3808
XComponent ........................................................................................................................ 3808
XComponentImag ................................................................................................................ 3808
XPhaseAngle ........................................................................................................................ 3808
YComponent ........................................................................................................................ 3808
YComponentImag ................................................................................................................ 3809
YPhaseAngle ........................................................................................................................ 3809
ZComponent ........................................................................................................................ 3809
ZComponentImag ................................................................................................................ 3809
ZPhaseAngle ........................................................................................................................ 3809
GetActivateAtLoadStep(uint) ................................................................................................ 3809
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3810
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3810
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3810
FrictionlessSupport ..................................................................................................................... 3811

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

DataModelObjectCategory ................................................................................................... 3812


InternalObject ...................................................................................................................... 3812
Location ............................................................................................................................... 3812
GeneralizedPlaneStrain ............................................................................................................... 3812
BoundaryConditionAlongFiber ............................................................................................. 3813
BoundaryConditionForRotationAboutX ................................................................................. 3813
BoundaryConditionForRotationAboutY ................................................................................. 3813
Children ............................................................................................................................... 3814
Comments ............................................................................................................................ 3814
CoordinateSystem ................................................................................................................ 3814
DataModelObjectCategory ................................................................................................... 3814
Figures ................................................................................................................................. 3814
Images ................................................................................................................................. 3814
InternalObject ...................................................................................................................... 3815
MagnitudeAlongFiber ........................................................................................................... 3815
MagnitudeRotationX ............................................................................................................ 3815
MagnitudeRotationY ............................................................................................................. 3815
Suppressed ........................................................................................................................... 3815
XCoordinateOfRefPoint ......................................................................................................... 3815
YCoordinateOfRefPoint ......................................................................................................... 3816
AddComment() ..................................................................................................................... 3816
AddFigure() .......................................................................................................................... 3816
AddImage(string) .................................................................................................................. 3816
Delete() ................................................................................................................................ 3816
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3817
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3817
GenericBoundaryCondition ........................................................................................................ 3818
Children ............................................................................................................................... 3818
Comments ............................................................................................................................ 3818
DataModelObjectCategory ................................................................................................... 3819
Figures ................................................................................................................................. 3819
Images ................................................................................................................................. 3819
InternalObject ...................................................................................................................... 3819
SharedRefBody ..................................................................................................................... 3819
Suppressed ........................................................................................................................... 3819
AddComment() ..................................................................................................................... 3820
AddFigure() .......................................................................................................................... 3820
AddImage(string) .................................................................................................................. 3820
Delete() ................................................................................................................................ 3820
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3820
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3821
PromoteToNamedSelection() ................................................................................................ 3821
GeometryBasedAdaptivity .......................................................................................................... 3822
DataModelObjectCategory ................................................................................................... 3824
InternalObject ...................................................................................................................... 3825
HeatFlow .................................................................................................................................... 3825
DataModelObjectCategory ................................................................................................... 3826
DefineAs ............................................................................................................................... 3826
InternalObject ...................................................................................................................... 3826
Location ............................................................................................................................... 3826
Magnitude ............................................................................................................................ 3826

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

NumberOfSegments ............................................................................................................. 3827


GetActivateAtLoadStep(uint) ................................................................................................ 3827
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3827
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3827
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3828
HeatFlux ..................................................................................................................................... 3828
DataModelObjectCategory ................................................................................................... 3829
GraphControlsXAxis .............................................................................................................. 3830
IndependentVariable ............................................................................................................ 3830
InternalObject ...................................................................................................................... 3830
Location ............................................................................................................................... 3830
Magnitude ............................................................................................................................ 3830
NumberOfSegments ............................................................................................................. 3830
XYZFunctionCoordinateSystem ............................................................................................. 3831
GetActivateAtLoadStep(uint) ................................................................................................ 3831
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3831
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3831
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3832
HydrostaticPressure .................................................................................................................... 3832
AppliedBy ............................................................................................................................. 3834
CoordinateSystem ................................................................................................................ 3834
DataModelObjectCategory ................................................................................................... 3834
DefineBy ............................................................................................................................... 3834
Direction .............................................................................................................................. 3834
FluidDensity ......................................................................................................................... 3834
InternalObject ...................................................................................................................... 3835
Location ............................................................................................................................... 3835
Magnitude ............................................................................................................................ 3835
ShellFace .............................................................................................................................. 3835
XComponent ........................................................................................................................ 3835
XCoordinate ......................................................................................................................... 3835
YComponent ........................................................................................................................ 3836
YCoordinate .......................................................................................................................... 3836
ZComponent ........................................................................................................................ 3836
ZCoordinate ......................................................................................................................... 3836
GetActivateAtLoadStep(uint) ................................................................................................ 3836
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3837
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3837
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3837
ImpedanceBoundary .................................................................................................................. 3838
DataModelObjectCategory ................................................................................................... 3839
InternalObject ...................................................................................................................... 3839
Location ............................................................................................................................... 3839
MaterialImpedance ............................................................................................................... 3839
ReferencePressure ................................................................................................................ 3839
ReferenceVelocity ................................................................................................................. 3839
ImportedCFDPressure ................................................................................................................. 3840
CFDPressureFile .................................................................................................................... 3840
DataModelObjectCategory ................................................................................................... 3841
InternalObject ...................................................................................................................... 3841
Location ............................................................................................................................... 3841

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

InternalHeatGeneration .............................................................................................................. 3841


DataModelObjectCategory ................................................................................................... 3842
InternalObject ...................................................................................................................... 3842
Location ............................................................................................................................... 3842
Magnitude ............................................................................................................................ 3842
NumberOfSegments ............................................................................................................. 3843
GetActivateAtLoadStep(uint) ................................................................................................ 3843
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3843
JointLoad ................................................................................................................................... 3843
Children ............................................................................................................................... 3844
Comments ............................................................................................................................ 3845
CutoffFrequency ................................................................................................................... 3845
DataModelObjectCategory ................................................................................................... 3845
DOF ...................................................................................................................................... 3845
Figures ................................................................................................................................. 3845
FittingMethod ...................................................................................................................... 3845
Images ................................................................................................................................. 3846
InternalObject ...................................................................................................................... 3846
Joint ..................................................................................................................................... 3846
JointConditionType .............................................................................................................. 3846
LockAtLoadStep .................................................................................................................... 3846
Magnitude ............................................................................................................................ 3846
NumberOfSegments ............................................................................................................. 3847
Suppressed ........................................................................................................................... 3847
AddCommandSnippet() ........................................................................................................ 3847
AddComment() ..................................................................................................................... 3847
AddFigure() .......................................................................................................................... 3847
AddImage(string) .................................................................................................................. 3847
Delete() ................................................................................................................................ 3848
GetActivateAtLoadStep(uint) ................................................................................................ 3848
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3848
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3849
RenameBasedOnDefinition() ................................................................................................. 3849
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3849
LegacyThermalCondition ............................................................................................................ 3850
Children ............................................................................................................................... 3850
Comments ............................................................................................................................ 3850
DataModelObjectCategory ................................................................................................... 3851
Figures ................................................................................................................................. 3851
Images ................................................................................................................................. 3851
InternalObject ...................................................................................................................... 3851
AddComment() ..................................................................................................................... 3851
AddFigure() .......................................................................................................................... 3851
AddImage(string) .................................................................................................................. 3852
Delete() ................................................................................................................................ 3852
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3852
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3853
LimitBoundary ............................................................................................................................ 3853
DataModelObjectCategory ................................................................................................... 3854
InternalObject ...................................................................................................................... 3854
LimitBCDirection .................................................................................................................. 3854

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

LimitBCMax .......................................................................................................................... 3855


LimitBCMaxX ........................................................................................................................ 3855
LimitBCMaxY ........................................................................................................................ 3855
LimitBCMaxZ ........................................................................................................................ 3855
LimitBCMin ........................................................................................................................... 3855
LimitBCMinX ......................................................................................................................... 3855
LimitBCMinY ......................................................................................................................... 3856
LimitBCMinZ ......................................................................................................................... 3856
Location ............................................................................................................................... 3856
LinePressure ............................................................................................................................... 3856
CoordinateSystem ................................................................................................................ 3857
DataModelObjectCategory ................................................................................................... 3858
DefineBy ............................................................................................................................... 3858
Direction .............................................................................................................................. 3858
GraphControlsXAxis .............................................................................................................. 3858
IndependentVariable ............................................................................................................ 3858
InternalObject ...................................................................................................................... 3858
Location ............................................................................................................................... 3859
Magnitude ............................................................................................................................ 3859
NumberOfSegments ............................................................................................................. 3859
PhaseAngle .......................................................................................................................... 3859
RangeMaximum ................................................................................................................... 3859
RangeMinimum .................................................................................................................... 3859
XComponent ........................................................................................................................ 3860
XYZFunctionCoordinateSystem ............................................................................................. 3860
YComponent ........................................................................................................................ 3860
ZComponent ........................................................................................................................ 3860
GetActivateAtLoadStep(uint) ................................................................................................ 3860
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3861
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3861
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3861
LoadGroup ................................................................................................................................. 3862
Children ............................................................................................................................... 3863
Comments ............................................................................................................................ 3863
ConductingArea ................................................................................................................... 3864
ConductorCurrent ................................................................................................................. 3864
ConductorType ..................................................................................................................... 3864
CoordinateSystem ................................................................................................................ 3864
DataImportStatus ................................................................................................................. 3864
DataModelObjectCategory ................................................................................................... 3864
Figures ................................................................................................................................. 3865
FilterByOrder ........................................................................................................................ 3865
GroupingType ...................................................................................................................... 3865
Images ................................................................................................................................. 3865
ImportedDataType ................................................................................................................ 3865
InternalObject ...................................................................................................................... 3865
InterpolateRPM ..................................................................................................................... 3866
Location ............................................................................................................................... 3866
NumberOfFrequenciesToConsider ......................................................................................... 3866
NumberOfPoints ................................................................................................................... 3866
NumberOfTurns .................................................................................................................... 3866

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

OnDataRefreshOption ........................................................................................................... 3866


Orders .................................................................................................................................. 3867
PhaseAngle .......................................................................................................................... 3867
RPMFileSelection .................................................................................................................. 3867
SolutionId ............................................................................................................................. 3867
Suppressed ........................................................................................................................... 3867
TransferFileName .................................................................................................................. 3867
UseInternalRemotePoints ...................................................................................................... 3868
AddComment() ..................................................................................................................... 3868
AddCurrent() ........................................................................................................................ 3868
AddFigure() .......................................................................................................................... 3868
AddImage(string) .................................................................................................................. 3868
AddVoltage() ........................................................................................................................ 3869
Delete() ................................................................................................................................ 3869
DeleteChildren(bool) ............................................................................................................ 3869
GenerateRemoteLoads() ....................................................................................................... 3869
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3869
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3870
MagneticFluxParallel ................................................................................................................... 3870
DataModelObjectCategory ................................................................................................... 3871
InternalObject ...................................................................................................................... 3871
Location ............................................................................................................................... 3871
MassFlowRate ............................................................................................................................. 3872
DataModelObjectCategory ................................................................................................... 3872
InternalObject ...................................................................................................................... 3873
Location ............................................................................................................................... 3873
Magnitude ............................................................................................................................ 3873
Moment ..................................................................................................................................... 3873
BeamMaterial ....................................................................................................................... 3875
BeamRadius .......................................................................................................................... 3875
Behavior ............................................................................................................................... 3875
CoordinateSystem ................................................................................................................ 3875
DataModelObjectCategory ................................................................................................... 3876
DefineBy ............................................................................................................................... 3876
Direction .............................................................................................................................. 3876
HarmonicIndex ..................................................................................................................... 3876
IndependentVariable ............................................................................................................ 3876
InternalObject ...................................................................................................................... 3876
LoadingApplicationType ....................................................................................................... 3877
Location ............................................................................................................................... 3877
Magnitude ............................................................................................................................ 3877
MagnitudeImag .................................................................................................................... 3877
NonCyclicLoadingType ......................................................................................................... 3877
NumberOfSegments ............................................................................................................. 3877
PhaseAngle .......................................................................................................................... 3878
PinballRegion ....................................................................................................................... 3878
RemotePoint ......................................................................................................................... 3878
RpmSelection ....................................................................................................................... 3878
SectorNumber ...................................................................................................................... 3878
StepSelection ....................................................................................................................... 3878
StepVarying .......................................................................................................................... 3879

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

XComponent ........................................................................................................................ 3879


XComponentImag ................................................................................................................ 3879
XPhaseAngle ........................................................................................................................ 3879
YComponent ........................................................................................................................ 3879
YComponentImag ................................................................................................................ 3879
YPhaseAngle ........................................................................................................................ 3880
ZComponent ........................................................................................................................ 3880
ZComponentImag ................................................................................................................ 3880
ZPhaseAngle ........................................................................................................................ 3880
GetActivateAtLoadStep(uint) ................................................................................................ 3880
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3881
PromoteToRemotePoint() ...................................................................................................... 3881
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3881
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3881
NodalDisplacement .................................................................................................................... 3882
CoordinateSystem ................................................................................................................ 3883
DataModelObjectCategory ................................................................................................... 3883
DynamicRelaxationBehavior ................................................................................................. 3884
GraphControlsXAxis .............................................................................................................. 3884
IndependentVariable ............................................................................................................ 3884
InternalObject ...................................................................................................................... 3884
Location ............................................................................................................................... 3884
NumberOfSegments ............................................................................................................. 3884
PhaseAngle .......................................................................................................................... 3885
RangeMaximum ................................................................................................................... 3885
RangeMinimum .................................................................................................................... 3885
ReverseDirectionForInverseSteps .......................................................................................... 3885
XComponent ........................................................................................................................ 3885
XYZFunctionCoordinateSystem ............................................................................................. 3885
YComponent ........................................................................................................................ 3886
ZComponent ........................................................................................................................ 3886
GetActivateAtLoadStep(uint) ................................................................................................ 3886
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3886
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3887
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3887
NodalForce ................................................................................................................................. 3887
CoordinateSystem ................................................................................................................ 3889
DataModelObjectCategory ................................................................................................... 3889
DivideLoadByNodes .............................................................................................................. 3889
DynamicRelaxationBehavior ................................................................................................. 3889
GraphControlsXAxis .............................................................................................................. 3890
HarmonicIndex ..................................................................................................................... 3890
IndependentVariable ............................................................................................................ 3890
InternalObject ...................................................................................................................... 3890
LoadVectorAssignment ......................................................................................................... 3890
LoadVectorNumber .............................................................................................................. 3890
Location ............................................................................................................................... 3891
NonCyclicLoadingType ......................................................................................................... 3891
NumberOfSegments ............................................................................................................. 3891
PhaseAngle .......................................................................................................................... 3891
RangeMaximum ................................................................................................................... 3891

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

RangeMinimum .................................................................................................................... 3891


SectorNumber ...................................................................................................................... 3892
XComponent ........................................................................................................................ 3892
XYZFunctionCoordinateSystem ............................................................................................. 3892
YComponent ........................................................................................................................ 3892
ZComponent ........................................................................................................................ 3892
GetActivateAtLoadStep(uint) ................................................................................................ 3892
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3893
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3893
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3893
NodalOrientation ........................................................................................................................ 3894
Children ............................................................................................................................... 3894
Comments ............................................................................................................................ 3895
CoordinateSystem ................................................................................................................ 3895
DataModelObjectCategory ................................................................................................... 3895
Images ................................................................................................................................. 3895
InternalObject ...................................................................................................................... 3895
Location ............................................................................................................................... 3895
Suppressed ........................................................................................................................... 3896
AddComment() ..................................................................................................................... 3896
AddImage(string) .................................................................................................................. 3896
Delete() ................................................................................................................................ 3896
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3896
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3897
NodalPressure ............................................................................................................................ 3897
DataModelObjectCategory ................................................................................................... 3899
DefineBy ............................................................................................................................... 3899
GraphControlsXAxis .............................................................................................................. 3899
IndependentVariable ............................................................................................................ 3899
InternalObject ...................................................................................................................... 3899
LoadVectorAssignment ......................................................................................................... 3900
LoadVectorNumber .............................................................................................................. 3900
Location ............................................................................................................................... 3900
Magnitude ............................................................................................................................ 3900
NumberOfSegments ............................................................................................................. 3900
RangeMaximum ................................................................................................................... 3900
RangeMinimum .................................................................................................................... 3901
XYZFunctionCoordinateSystem ............................................................................................. 3901
GetActivateAtLoadStep(uint) ................................................................................................ 3901
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3901
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3902
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3902
NodalRotation ............................................................................................................................ 3902
CoordinateSystem ................................................................................................................ 3903
DataModelObjectCategory ................................................................................................... 3904
InternalObject ...................................................................................................................... 3904
Location ............................................................................................................................... 3904
RotationX ............................................................................................................................. 3904
RotationY ............................................................................................................................. 3904
RotationZ ............................................................................................................................. 3904
NonlinearAdaptiveRegion ........................................................................................................... 3905

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

BufferElements ..................................................................................................................... 3906


BufferLayers .......................................................................................................................... 3906
CheckAt ................................................................................................................................ 3906
CheckAtValue ....................................................................................................................... 3906
Children ............................................................................................................................... 3907
Comments ............................................................................................................................ 3907
CoordinateSystem ................................................................................................................ 3907
Criterion ............................................................................................................................... 3907
DataModelObjectCategory ................................................................................................... 3907
EndTime ............................................................................................................................... 3907
EnergyCoefficient ................................................................................................................. 3908
Figures ................................................................................................................................. 3908
HexDomCheckAt .................................................................................................................. 3908
HexDomCheckAtValue .......................................................................................................... 3908
HexDomEndTime ................................................................................................................. 3908
HexDomStartTime ................................................................................................................ 3908
HexDomTimeRange .............................................................................................................. 3909
Images ................................................................................................................................. 3909
InternalObject ...................................................................................................................... 3909
JacobianRatioValue ............................................................................................................... 3909
LengthX ............................................................................................................................... 3909
LengthY ................................................................................................................................ 3909
LengthZ ................................................................................................................................ 3910
Location ............................................................................................................................... 3910
MaximumCornerAngle .......................................................................................................... 3910
Option .................................................................................................................................. 3910
RemeshLayerEnd .................................................................................................................. 3910
RemeshLayerFrequency ........................................................................................................ 3910
RemeshLayerStart ................................................................................................................. 3911
SkewnessValue ..................................................................................................................... 3911
StartTime .............................................................................................................................. 3911
Suppressed ........................................................................................................................... 3911
TimeRange ........................................................................................................................... 3911
AddComment() ..................................................................................................................... 3911
AddFigure() .......................................................................................................................... 3912
AddImage(string) .................................................................................................................. 3912
Delete() ................................................................................................................................ 3912
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3912
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3913
PerfectlyInsulated ....................................................................................................................... 3913
DataModelObjectCategory ................................................................................................... 3914
DefineAs ............................................................................................................................... 3914
InternalObject ...................................................................................................................... 3914
Location ............................................................................................................................... 3914
Magnitude ............................................................................................................................ 3915
PipePressure ............................................................................................................................... 3915
DataModelObjectCategory ................................................................................................... 3916
GraphControlsXAxis .............................................................................................................. 3916
IndependentVariable ............................................................................................................ 3916
InternalObject ...................................................................................................................... 3917
Loading ................................................................................................................................ 3917

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

Location ............................................................................................................................... 3917


Magnitude ............................................................................................................................ 3917
NumberOfSegments ............................................................................................................. 3917
PhaseAngle .......................................................................................................................... 3917
RangeMaximum ................................................................................................................... 3918
RangeMinimum .................................................................................................................... 3918
XYZFunctionCoordinateSystem ............................................................................................. 3918
GetActivateAtLoadStep(uint) ................................................................................................ 3918
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3918
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3919
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3919
PipeTemperature ........................................................................................................................ 3920
DataModelObjectCategory ................................................................................................... 3921
GraphControlsXAxis .............................................................................................................. 3921
IndependentVariable ............................................................................................................ 3921
InternalObject ...................................................................................................................... 3921
Loading ................................................................................................................................ 3921
Location ............................................................................................................................... 3921
Magnitude ............................................................................................................................ 3922
NumberOfSegments ............................................................................................................. 3922
RangeMaximum ................................................................................................................... 3922
RangeMinimum .................................................................................................................... 3922
XYZFunctionCoordinateSystem ............................................................................................. 3922
GetActivateAtLoadStep(uint) ................................................................................................ 3922
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3923
PlasticHeating ............................................................................................................................. 3923
DataModelObjectCategory ................................................................................................... 3924
InternalObject ...................................................................................................................... 3924
PlasticWorkFraction .............................................................................................................. 3924
Pressure ...................................................................................................................................... 3924
AppliedBy ............................................................................................................................. 3926
ApplyTo ................................................................................................................................ 3926
CoordinateSystem ................................................................................................................ 3926
CrackGrowth ......................................................................................................................... 3927
DataModelObjectCategory ................................................................................................... 3927
DefineBy ............................................................................................................................... 3927
Direction .............................................................................................................................. 3927
DynamicRelaxationBehavior ................................................................................................. 3927
GraphControlsXAxis .............................................................................................................. 3927
HarmonicIndex ..................................................................................................................... 3928
IndependentVariable ............................................................................................................ 3928
InternalObject ...................................................................................................................... 3928
LoadedArea .......................................................................................................................... 3928
LoadVectorAssignment ......................................................................................................... 3928
LoadVectorNumber .............................................................................................................. 3928
Location ............................................................................................................................... 3929
Magnitude ............................................................................................................................ 3929
MagnitudeImag .................................................................................................................... 3929
NonCyclicLoadingType ......................................................................................................... 3929
NumberOfSegments ............................................................................................................. 3929
PhaseAngle .......................................................................................................................... 3929

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

RangeMaximum ................................................................................................................... 3930


RangeMinimum .................................................................................................................... 3930
ScopingMethod .................................................................................................................... 3930
SectorNumber ...................................................................................................................... 3930
XComponent ........................................................................................................................ 3930
XComponentImag ................................................................................................................ 3930
XPhaseAngle ........................................................................................................................ 3931
XYZFunctionCoordinateSystem ............................................................................................. 3931
YComponent ........................................................................................................................ 3931
YComponentImag ................................................................................................................ 3931
YPhaseAngle ........................................................................................................................ 3931
ZComponent ........................................................................................................................ 3931
ZComponentImag ................................................................................................................ 3932
ZPhaseAngle ........................................................................................................................ 3932
GetActivateAtLoadStep(uint) ................................................................................................ 3932
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3932
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3933
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3933
PSDAcceleration ......................................................................................................................... 3933
DataModelObjectCategory ................................................................................................... 3934
InternalObject ...................................................................................................................... 3934
LoadData .............................................................................................................................. 3935
PSDDisplacement ....................................................................................................................... 3935
DataModelObjectCategory ................................................................................................... 3935
InternalObject ...................................................................................................................... 3936
LoadData .............................................................................................................................. 3936
PSDGAcceleration ....................................................................................................................... 3936
DataModelObjectCategory ................................................................................................... 3937
InternalObject ...................................................................................................................... 3937
LoadData .............................................................................................................................. 3937
PSDLoad ..................................................................................................................................... 3937
BoundaryCondition .............................................................................................................. 3938
Children ............................................................................................................................... 3938
Comments ............................................................................................................................ 3938
DataModelObjectCategory ................................................................................................... 3938
Direction .............................................................................................................................. 3939
Figures ................................................................................................................................. 3939
Images ................................................................................................................................. 3939
InternalObject ...................................................................................................................... 3939
Suppressed ........................................................................................................................... 3939
AddComment() ..................................................................................................................... 3939
AddFigure() .......................................................................................................................... 3940
AddImage(string) .................................................................................................................. 3940
Delete() ................................................................................................................................ 3940
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3940
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3941
PSDVelocity ................................................................................................................................ 3941
DataModelObjectCategory ................................................................................................... 3942
InternalObject ...................................................................................................................... 3942
LoadData .............................................................................................................................. 3942
Radiation .................................................................................................................................... 3942

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

AmbientTemperature ............................................................................................................ 3944


Correlation ........................................................................................................................... 3944
DataModelObjectCategory ................................................................................................... 3944
EditDataFor .......................................................................................................................... 3944
Emissivity ............................................................................................................................. 3944
Enclosure .............................................................................................................................. 3945
EnclosureType ...................................................................................................................... 3945
InternalObject ...................................................................................................................... 3945
Location ............................................................................................................................... 3945
NumberOfSegments ............................................................................................................. 3945
ShellFace .............................................................................................................................. 3945
GetActivateAtLoadStep(uint) ................................................................................................ 3946
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3946
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3946
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3947
RemoteDisplacement ................................................................................................................. 3947
BeamMaterial ....................................................................................................................... 3948
BeamRadius .......................................................................................................................... 3949
Behavior ............................................................................................................................... 3949
CoordinateSystem ................................................................................................................ 3949
DataModelObjectCategory ................................................................................................... 3949
DynamicRelaxationBehavior ................................................................................................. 3949
InternalObject ...................................................................................................................... 3949
Location ............................................................................................................................... 3950
NumberOfSegments ............................................................................................................. 3950
PinballRegion ....................................................................................................................... 3950
RemotePoint ......................................................................................................................... 3950
ReverseDirectionForInverseSteps .......................................................................................... 3950
RotationX ............................................................................................................................. 3950
RotationY ............................................................................................................................. 3951
RotationZ ............................................................................................................................. 3951
XComponent ........................................................................................................................ 3951
XCoordinate ......................................................................................................................... 3951
YComponent ........................................................................................................................ 3951
YCoordinate .......................................................................................................................... 3951
ZComponent ........................................................................................................................ 3952
ZCoordinate ......................................................................................................................... 3952
GetActivateAtLoadStep(uint) ................................................................................................ 3952
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3952
PromoteToRemotePoint() ...................................................................................................... 3953
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3953
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3953
RemoteForce .............................................................................................................................. 3954
BeamMaterial ....................................................................................................................... 3955
BeamRadius .......................................................................................................................... 3956
Behavior ............................................................................................................................... 3956
CoordinateSystem ................................................................................................................ 3956
DataModelObjectCategory ................................................................................................... 3956
DefineBy ............................................................................................................................... 3956
Direction .............................................................................................................................. 3956
FollowerLoad ........................................................................................................................ 3957

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

HarmonicIndex ..................................................................................................................... 3957


IndependentVariable ............................................................................................................ 3957
InternalObject ...................................................................................................................... 3957
LoadingApplicationType ....................................................................................................... 3957
Location ............................................................................................................................... 3957
Magnitude ............................................................................................................................ 3958
MagnitudeImag .................................................................................................................... 3958
NonCyclicLoadingType ......................................................................................................... 3958
NumberOfSegments ............................................................................................................. 3958
PhaseAngle .......................................................................................................................... 3958
PinballRegion ....................................................................................................................... 3958
RpmSelection ....................................................................................................................... 3959
SectorNumber ...................................................................................................................... 3959
StepSelection ....................................................................................................................... 3959
StepVarying .......................................................................................................................... 3959
XComponent ........................................................................................................................ 3959
XComponentImag ................................................................................................................ 3959
XCoordinate ......................................................................................................................... 3960
XPhaseAngle ........................................................................................................................ 3960
YComponent ........................................................................................................................ 3960
YComponentImag ................................................................................................................ 3960
YCoordinate .......................................................................................................................... 3960
YPhaseAngle ........................................................................................................................ 3960
ZComponent ........................................................................................................................ 3961
ZComponentImag ................................................................................................................ 3961
ZCoordinate ......................................................................................................................... 3961
ZPhaseAngle ........................................................................................................................ 3961
GetActivateAtLoadStep(uint) ................................................................................................ 3961
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3962
PromoteToRemotePoint() ...................................................................................................... 3962
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3962
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3963
RotatingForce ............................................................................................................................. 3963
Axis ...................................................................................................................................... 3964
AxisComponentX .................................................................................................................. 3965
AxisComponentY .................................................................................................................. 3965
AxisComponentZ .................................................................................................................. 3965
AxisLocationX ....................................................................................................................... 3965
AxisLocationY ....................................................................................................................... 3965
AxisLocationZ ....................................................................................................................... 3965
CalculatedFromUnbalancedMass .......................................................................................... 3966
CoordinateSystem ................................................................................................................ 3966
DataModelObjectCategory ................................................................................................... 3966
DefineBy ............................................................................................................................... 3966
HitPointLocationX ................................................................................................................. 3966
HitPointLocationY ................................................................................................................. 3966
HitPointLocationZ ................................................................................................................. 3967
HitPointNodeId ..................................................................................................................... 3967
HitPointRemotePointSelection .............................................................................................. 3967
HitPointSelection .................................................................................................................. 3967
InternalObject ...................................................................................................................... 3967

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

Location ............................................................................................................................... 3967


Mass ..................................................................................................................................... 3968
PhaseAngle .......................................................................................................................... 3968
RemotePointSelection .......................................................................................................... 3968
RotatingRadius ..................................................................................................................... 3968
SynchronousRatio ................................................................................................................. 3968
UnbalancedForceMagnitude ................................................................................................. 3968
XCoordinate ......................................................................................................................... 3969
YCoordinate .......................................................................................................................... 3969
ZCoordinate ......................................................................................................................... 3969
RotationalAcceleration ................................................................................................................ 3969
CoordinateSystem ................................................................................................................ 3970
DataModelObjectCategory ................................................................................................... 3970
DefineBy ............................................................................................................................... 3971
IndependentVariable ............................................................................................................ 3971
InternalObject ...................................................................................................................... 3971
Location ............................................................................................................................... 3971
Magnitude ............................................................................................................................ 3971
XComponent ........................................................................................................................ 3971
XCoordinate ......................................................................................................................... 3972
YComponent ........................................................................................................................ 3972
YCoordinate .......................................................................................................................... 3972
ZComponent ........................................................................................................................ 3972
ZCoordinate ......................................................................................................................... 3972
GetActivateAtLoadStep(uint) ................................................................................................ 3972
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3973
RotationalVelocity ....................................................................................................................... 3973
CoordinateSystem ................................................................................................................ 3974
DataModelObjectCategory ................................................................................................... 3974
DefineBy ............................................................................................................................... 3974
IndependentVariable ............................................................................................................ 3975
InternalObject ...................................................................................................................... 3975
Location ............................................................................................................................... 3975
Magnitude ............................................................................................................................ 3975
XComponent ........................................................................................................................ 3975
XCoordinate ......................................................................................................................... 3975
YComponent ........................................................................................................................ 3976
YCoordinate .......................................................................................................................... 3976
ZComponent ........................................................................................................................ 3976
ZCoordinate ......................................................................................................................... 3976
GetActivateAtLoadStep(uint) ................................................................................................ 3976
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3977
RotationBoundaryCondition ....................................................................................................... 3977
Axis ...................................................................................................................................... 3978
Children ............................................................................................................................... 3978
Comments ............................................................................................................................ 3978
DataModelObjectCategory ................................................................................................... 3978
Figures ................................................................................................................................. 3978
Images ................................................................................................................................. 3979
InternalObject ...................................................................................................................... 3979
NumberOfSegments ............................................................................................................. 3979

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

Suppressed ........................................................................................................................... 3979


AddComment() ..................................................................................................................... 3979
AddFigure() .......................................................................................................................... 3979
AddImage(string) .................................................................................................................. 3980
Delete() ................................................................................................................................ 3980
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3980
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3980
RSAcceleration ............................................................................................................................ 3981
DataModelObjectCategory ................................................................................................... 3982
InternalObject ...................................................................................................................... 3982
LoadData .............................................................................................................................. 3983
RSDisplacement .......................................................................................................................... 3983
DataModelObjectCategory ................................................................................................... 3984
InternalObject ...................................................................................................................... 3984
LoadData .............................................................................................................................. 3984
RSLoad ....................................................................................................................................... 3985
BoundaryCondition .............................................................................................................. 3985
Children ............................................................................................................................... 3986
Comments ............................................................................................................................ 3986
DataModelObjectCategory ................................................................................................... 3986
Direction .............................................................................................................................. 3986
Figures ................................................................................................................................. 3986
Images ................................................................................................................................. 3986
InternalObject ...................................................................................................................... 3987
MissingMassEffect ................................................................................................................ 3987
MissingMassEffectZPA ........................................................................................................... 3987
RigidResponseEffect ............................................................................................................. 3987
RigidResponseEffectFreqBegin .............................................................................................. 3987
RigidResponseEffectFreqEnd ................................................................................................. 3987
RigidResponseEffectType ...................................................................................................... 3988
RigidResponseEffectZPA ....................................................................................................... 3988
ScaleFactor ........................................................................................................................... 3988
Suppressed ........................................................................................................................... 3988
AddComment() ..................................................................................................................... 3988
AddFigure() .......................................................................................................................... 3988
AddImage(string) .................................................................................................................. 3989
Delete() ................................................................................................................................ 3989
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3989
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3990
RSVelocity ................................................................................................................................... 3990
DataModelObjectCategory ................................................................................................... 3991
InternalObject ...................................................................................................................... 3991
LoadData .............................................................................................................................. 3992
SimplySupported ........................................................................................................................ 3992
DataModelObjectCategory ................................................................................................... 3993
InternalObject ...................................................................................................................... 3993
Location ............................................................................................................................... 3993
SurfaceChargeDensity ................................................................................................................ 3993
DataModelObjectCategory ................................................................................................... 3994
InternalObject ...................................................................................................................... 3994
Location ............................................................................................................................... 3994

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

Magnitude ............................................................................................................................ 3994


Temperature ............................................................................................................................... 3995
ApplyToEntireBody ............................................................................................................... 3996
DataModelObjectCategory ................................................................................................... 3996
DefineBy ............................................................................................................................... 3996
GraphControlsXAxis .............................................................................................................. 3996
IndependentVariable ............................................................................................................ 3996
InternalObject ...................................................................................................................... 3997
Location ............................................................................................................................... 3997
Magnitude ............................................................................................................................ 3997
NumberOfSegments ............................................................................................................. 3997
RangeMaximum ................................................................................................................... 3997
RangeMinimum .................................................................................................................... 3997
ShellFace .............................................................................................................................. 3998
XYZFunctionCoordinateSystem ............................................................................................. 3998
GetActivateAtLoadStep(uint) ................................................................................................ 3998
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3998
ThermalCondition ....................................................................................................................... 3999
DataModelObjectCategory ................................................................................................... 4000
DefineBy ............................................................................................................................... 4000
GraphControlsXAxis .............................................................................................................. 4000
IndependentVariable ............................................................................................................ 4000
InternalObject ...................................................................................................................... 4000
LoadVectorAssignment ......................................................................................................... 4001
LoadVectorNumber .............................................................................................................. 4001
Location ............................................................................................................................... 4001
Magnitude ............................................................................................................................ 4001
NumberOfSegments ............................................................................................................. 4001
RangeMaximum ................................................................................................................... 4001
RangeMinimum .................................................................................................................... 4002
ShellFace .............................................................................................................................. 4002
XYZFunctionCoordinateSystem ............................................................................................. 4002
GetActivateAtLoadStep(uint) ................................................................................................ 4002
GetComponentActivateAtLoadStep(string, uint) .................................................................... 4002
SetActivateAtLoadStep(uint, bool) ......................................................................................... 4003
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 4003
Velocity ...................................................................................................................................... 4004
CoordinateSystem ................................................................................................................ 4005
DataModelObjectCategory ................................................................................................... 4005
DefineBy ............................................................................................................................... 4005
DynamicRelaxationBehavior ................................................................................................. 4005
InternalObject ...................................................................................................................... 4005
Location ............................................................................................................................... 4006
NumberOfSegments ............................................................................................................. 4006
XComponent ........................................................................................................................ 4006
YComponent ........................................................................................................................ 4006
ZComponent ........................................................................................................................ 4006
GetActivateAtLoadStep(uint) ................................................................................................ 4006
GetComponentActivateAtLoadStep(string, uint) .................................................................... 4007
SetActivateAtLoadStep(uint, bool) ......................................................................................... 4007
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 4007

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

ViscoelasticHeating ..................................................................................................................... 4008


DataModelObjectCategory ................................................................................................... 4009
InternalObject ...................................................................................................................... 4009
ViscoelasticLossFraction ........................................................................................................ 4009
Voltage ....................................................................................................................................... 4009
DataModelObjectCategory ................................................................................................... 4010
InternalObject ...................................................................................................................... 4010
Location ............................................................................................................................... 4010
Magnitude ............................................................................................................................ 4011
NumberOfSegments ............................................................................................................. 4011
PhaseAngle .......................................................................................................................... 4011
VoltageCoupling ................................................................................................................... 4011
GetActivateAtLoadStep(uint) ................................................................................................ 4011
SetActivateAtLoadStep(uint, bool) ......................................................................................... 4012
VoltageGround ........................................................................................................................... 4012
DataModelObjectCategory ................................................................................................... 4013
InternalObject ...................................................................................................................... 4013
Location ............................................................................................................................... 4013
VoltageCoupling ................................................................................................................... 4013
VolumeChargeDensity ................................................................................................................ 4013
DataModelObjectCategory ................................................................................................... 4014
InternalObject ...................................................................................................................... 4014
Location ............................................................................................................................... 4015
Magnitude ............................................................................................................................ 4015
Ansys.ACT.Automation.Mechanical.AnalysisSettings Namespace ................................................ 4017
AnalysisSettings .......................................................................................................................... 4017
Children ............................................................................................................................... 4018
Comments ............................................................................................................................ 4018
DataModelObjectCategory ................................................................................................... 4018
Figures ................................................................................................................................. 4018
Graph ................................................................................................................................... 4018
Images ................................................................................................................................. 4019
InternalObject ...................................................................................................................... 4019
ScratchSolverFilesDirectory ................................................................................................... 4019
SolverFilesDirectory .............................................................................................................. 4019
AddComment() ..................................................................................................................... 4019
AddFigure() .......................................................................................................................... 4019
AddImage(string) .................................................................................................................. 4020
DeleteAllRestartPoints() ........................................................................................................ 4020
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 4020
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 4021
ANSYSAnalysisSettings ............................................................................................................... 4021
AggressiveRemeshing ........................................................................................................... 4039
AMCooldownNumberOfSubsteps ......................................................................................... 4039
AMPSConvergence ............................................................................................................... 4039
AMStepType ......................................................................................................................... 4039
AMSubstepsBetweenHeating ................................................................................................ 4040
AMSubstepsToApplyHeats .................................................................................................... 4040
AutomaticTimeStepping ....................................................................................................... 4040
AxisymmetryDivisions ........................................................................................................... 4040
BackStress ............................................................................................................................ 4040

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

BaseRemovalType ................................................................................................................. 4040


BoundaryAngle .................................................................................................................... 4041
CacheResultsInMemory ........................................................................................................ 4041
CalculateAcceleration ........................................................................................................... 4041
CalculateEnergy .................................................................................................................... 4041
CalculateEulerAngles ............................................................................................................ 4041
CalculateReactions ................................................................................................................ 4041
CalculateThermalFlux ............................................................................................................ 4042
CalculateVelocity .................................................................................................................. 4042
CalculateVelocityAndAcceleration ......................................................................................... 4042
CalculateVolumeEnergy ........................................................................................................ 4042
CampbellDiagram ................................................................................................................. 4042
CarryOverTimeStep .............................................................................................................. 4042
CentralFrequency ................................................................................................................. 4043
ChargeConvergence ............................................................................................................. 4043
ChargeConvergenceMinimumReference ............................................................................... 4043
ChargeConvergenceTolerance ............................................................................................... 4043
ChargeConvergenceValue ..................................................................................................... 4043
ClusterNumber ..................................................................................................................... 4043
ClusterResults ....................................................................................................................... 4044
CombineRestartFiles ............................................................................................................. 4044
ConstantDamping ................................................................................................................ 4044
ConstantDampingRatio ........................................................................................................ 4044
ContactData ......................................................................................................................... 4044
ContactMiscellaneous ........................................................................................................... 4044
ContactSplit .......................................................................................................................... 4045
ContactSplitMaxNum ............................................................................................................ 4045
ContactSummary .................................................................................................................. 4045
CooldownTime ..................................................................................................................... 4045
CooldownTimeType .............................................................................................................. 4045
CoriolisEffectApplied ............................................................................................................ 4045
CreepEffects ......................................................................................................................... 4046
CreepLimitRatio .................................................................................................................... 4046
CSGConvergence .................................................................................................................. 4046
CStarIntegral ......................................................................................................................... 4046
CurrentConvergence ............................................................................................................. 4046
CurrentConvergenceMinimumReference ............................................................................... 4046
CurrentConvergenceTolerance .............................................................................................. 4047
CurrentConvergenceValue .................................................................................................... 4047
CurrentRestartPoint .............................................................................................................. 4047
CurrentStepNumber ............................................................................................................. 4047
CurrentStepNumberHarmonic .............................................................................................. 4047
CyclicModeSuperposition ..................................................................................................... 4047
Damped ............................................................................................................................... 4048
DampingDefineBy ................................................................................................................ 4048
DampingRatio ...................................................................................................................... 4048
DataModelObjectCategory ................................................................................................... 4048
DefineBy ............................................................................................................................... 4048
DeleteUnneededFiles ............................................................................................................ 4048
DisplacementConvergence ................................................................................................... 4049
DisplacementConvergenceMinimumReference ..................................................................... 4049

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

DisplacementConvergenceTolerance .................................................................................... 4049


DisplacementConvergenceValue ........................................................................................... 4049
EdgeSplittingAngle ............................................................................................................... 4049
ElectricOnly .......................................................................................................................... 4049
ElectromagneticNodalForces ................................................................................................ 4050
ElementCurrentDensity ......................................................................................................... 4050
EmagAMPSConvergenceMinimumReference ......................................................................... 4050
EmagAMPSConvergenceTolerance ........................................................................................ 4050
EmagAMPSConvergenceValue .............................................................................................. 4050
EmagCSGConvergenceMinimumReference ........................................................................... 4050
EmagCSGConvergenceTolerance ........................................................................................... 4051
EmagCSGConvergenceValue ................................................................................................. 4051
EnergyConvergence .............................................................................................................. 4051
EnergyConvergenceMinimumReference ................................................................................ 4051
EnergyConvergenceTolerance ............................................................................................... 4051
EnergyConvergenceValue ..................................................................................................... 4051
EngineOrderofExcitation ....................................................................................................... 4052
EqvDampingRatioFromModal ............................................................................................... 4052
ExcludeInsignificantModes ................................................................................................... 4052
ExpandResultsFrom .............................................................................................................. 4052
Expansion ............................................................................................................................. 4052
ExportHighStrains ................................................................................................................. 4052
ExportLayerEndTemperature ................................................................................................. 4053
ExportRecoaterInterference .................................................................................................. 4053
FarFieldRadiationSurface ....................................................................................................... 4053
FieldIntensityandFluxDensity ................................................................................................ 4053
FluxConvergence .................................................................................................................. 4053
ForceConvergence ................................................................................................................ 4053
ForceConvergenceMinimumReference .................................................................................. 4054
ForceConvergenceTolerance ................................................................................................. 4054
ForceConvergenceValue ........................................................................................................ 4054
FractureSolverControls .......................................................................................................... 4054
Frequency ............................................................................................................................ 4054
FrequencySpacing ................................................................................................................ 4054
FutureAnalysis ...................................................................................................................... 4055
GeneralMiscellaneous ........................................................................................................... 4055
GeneralMiscellaneousOption ................................................................................................ 4055
GenerateMeshRestartPoints .................................................................................................. 4055
GenerateRestartPoints .......................................................................................................... 4055
GlobalSizeRatioQualityImprovement ..................................................................................... 4055
GlobalSizeRatioQualityRefinement ........................................................................................ 4056
HarmonicIndexInterval ......................................................................................................... 4056
HarmonicIndexRange ........................................................................................................... 4056
HarmonicOrders ................................................................................................................... 4056
HeatConvergence ................................................................................................................. 4056
HeatConvergenceMinimumReference ................................................................................... 4056
HeatConvergenceTolerance .................................................................................................. 4057
HeatConvergenceValue ......................................................................................................... 4057
HeatGenerationRate ............................................................................................................. 4057
HemicubeResolution ............................................................................................................ 4057
IgnoreAcousticDamping ....................................................................................................... 4057

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

IncludeNegativeLoadMultiplier ............................................................................................. 4057


IncludeResidualVector .......................................................................................................... 4058
InertiaRelief .......................................................................................................................... 4058
InitialSubsteps ...................................................................................................................... 4058
InitialTimeStep ..................................................................................................................... 4058
InternalObject ...................................................................................................................... 4058
InverseOption ....................................................................................................................... 4058
InverseOptionEndStep .......................................................................................................... 4059
JIntegral ............................................................................................................................... 4059
KeepModalResults ................................................................................................................ 4059
KeepPreStressLoadPattern .................................................................................................... 4059
KrylovResidualTolerance ....................................................................................................... 4059
KrylovSubspaceDimension .................................................................................................... 4059
KrylovSubspaceFrequency .................................................................................................... 4060
LargeDeflection .................................................................................................................... 4060
LayersToBuild ....................................................................................................................... 4060
LimitSearchToRange ............................................................................................................. 4060
LineSearch ............................................................................................................................ 4060
LoadStepValue ...................................................................................................................... 4060
MassCoefficient .................................................................................................................... 4061
MaterialForce ........................................................................................................................ 4061
MaximumHarmonicIndex ...................................................................................................... 4061
MaximumIteration ................................................................................................................ 4061
MaximumModesToFind ........................................................................................................ 4061
MaximumPointsToSavePerStep ............................................................................................. 4061
MaximumSubsteps ............................................................................................................... 4062
MaximumTimeStep .............................................................................................................. 4062
MeshLoadStepValue ............................................................................................................. 4062
MeshRetainFilesAfterFullSolve ............................................................................................... 4062
MeshSaveAtLoadStep ........................................................................................................... 4062
MeshSaveAtSubstep ............................................................................................................. 4062
MinimumElementSize ........................................................................................................... 4063
MinimumHarmonicIndex ...................................................................................................... 4063
MinimumSubsteps ................................................................................................................ 4063
MinimumTimeStep ............................................................................................................... 4063
ModalFrequencyRange ......................................................................................................... 4063
ModalNumberOfPoints ......................................................................................................... 4063
ModalRangeMaximum .......................................................................................................... 4064
ModalRangeMinimum .......................................................................................................... 4064
ModeReuse .......................................................................................................................... 4064
ModesCombinationType ....................................................................................................... 4064
ModeSelectionMethod ......................................................................................................... 4064
ModeSignificanceLevel ......................................................................................................... 4064
MomentConvergence ........................................................................................................... 4065
MomentConvergenceMinimumReference ............................................................................. 4065
MomentConvergenceTolerance ............................................................................................ 4065
MomentConvergenceValue ................................................................................................... 4065
Multistep .............................................................................................................................. 4065
MultistepType ....................................................................................................................... 4065
NamedSelection ................................................................................................................... 4066
NewtonRaphsonOption ........................................................................................................ 4066

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

NodalForces .......................................................................................................................... 4066


NonlinearData ...................................................................................................................... 4066
NonLinearFormulation .......................................................................................................... 4066
NonLinearSolution ................................................................................................................ 4066
NumberOfModesToUse ......................................................................................................... 4067
NumberOfRestartPoints ........................................................................................................ 4067
NumberOfRPMs .................................................................................................................... 4067
NumberOfSculptedLayersQualityImprovement ..................................................................... 4067
NumberOfSculptedLayersRefinement ................................................................................... 4067
NumberOfSteps .................................................................................................................... 4067
NumberOfSubSteps .............................................................................................................. 4068
NumberOfZones ................................................................................................................... 4068
NumericalDamping .............................................................................................................. 4068
NumericalDampingValue ...................................................................................................... 4068
NumLoadVectors .................................................................................................................. 4068
OnDemandExpansionOption ................................................................................................ 4068
OutputSelection ................................................................................................................... 4069
OverRelaxation ..................................................................................................................... 4069
ParticipationFactor ................................................................................................................ 4069
ProjectToGeometry ............................................................................................................... 4069
QuasiStaticSolution .............................................................................................................. 4069
RadiositySolver ..................................................................................................................... 4069
RangeMaximum ................................................................................................................... 4070
RangeMinimum .................................................................................................................... 4070
ReferenceTemperature .......................................................................................................... 4070
ReferenceTemperatureType .................................................................................................. 4070
RefinementAlgorithm ........................................................................................................... 4070
ReformulationTolerance ........................................................................................................ 4070
RelaxationTemperature ......................................................................................................... 4071
RelaxationTemperatureType ................................................................................................. 4071
RemeshingGradient .............................................................................................................. 4071
RemeshingToleranceQualityImprovement ............................................................................. 4071
RemeshingToleranceRefinement ........................................................................................... 4071
RemovalDirection ................................................................................................................. 4071
RemovalStepSize .................................................................................................................. 4072
RestartAtLoadStep ................................................................................................................ 4072
RestartAtSubstep .................................................................................................................. 4072
RestartAtTime ....................................................................................................................... 4072
RestartType .......................................................................................................................... 4072
ResultFileCompression .......................................................................................................... 4072
RetainFilesAfterFullSolve ....................................................................................................... 4073
RetainModesymFileAfterSolve ............................................................................................... 4073
RotationConvergence ........................................................................................................... 4073
RotationConvergenceMinimumReference ............................................................................. 4073
RotationConvergenceTolerance ............................................................................................ 4073
RpmCentralFrequency .......................................................................................................... 4073
RpmClusterNumber .............................................................................................................. 4074
RpmFrequencySpacing ......................................................................................................... 4074
RpmRangeMaximum ............................................................................................................ 4074
RpmRangeMinimum ............................................................................................................. 4074
RpmSolutionIntervals ........................................................................................................... 4074

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

RpmValue ............................................................................................................................. 4074


SaveAtLoadStep ................................................................................................................... 4075
SaveAtSubstep ..................................................................................................................... 4075
SaveMAPDLDB ...................................................................................................................... 4075
SaveSpecifiedLoadStep ......................................................................................................... 4075
ScatteredFieldFormulation .................................................................................................... 4075
ScatteringOutputType .......................................................................................................... 4075
SearchRangeMaximum ......................................................................................................... 4076
SearchRangeMinimum .......................................................................................................... 4076
SIFS ...................................................................................................................................... 4076
SignificanceThreshold ........................................................................................................... 4076
SolutionIntervals ................................................................................................................... 4076
SolutionMethod ................................................................................................................... 4076
SolverPivotChecking ............................................................................................................. 4077
SolverTolerance .................................................................................................................... 4077
SolverType ............................................................................................................................ 4077
SolverUnits ........................................................................................................................... 4077
SolverUnitSystem ................................................................................................................. 4077
SpectrumType ...................................................................................................................... 4077
SpinSoftening ....................................................................................................................... 4078
SpringStiffness ...................................................................................................................... 4078
SpringStiffnessFactor ............................................................................................................ 4078
SpringStiffnessValue ............................................................................................................. 4078
Stabilization .......................................................................................................................... 4078
StabilizationActivationForFirstSubstep .................................................................................. 4078
StabilizationDampingFactor .................................................................................................. 4079
StabilizationEnergyDissipationRatio ...................................................................................... 4079
StabilizationForceLimit .......................................................................................................... 4079
StabilizationMethod ............................................................................................................. 4079
StepEndTime ........................................................................................................................ 4079
StepName ............................................................................................................................ 4079
StiffnessCoefficient ............................................................................................................... 4080
StiffnessCoefficientDefineBy ................................................................................................. 4080
StoreComplexSolution .......................................................................................................... 4080
StoreModalResults ................................................................................................................ 4080
StoreResulsAtValue ............................................................................................................... 4080
StoreResultsAt ...................................................................................................................... 4080
StoreResultsAtAllFrequencies ................................................................................................ 4081
Strain .................................................................................................................................... 4081
Stress ................................................................................................................................... 4081
StructuralDampingCoefficient ............................................................................................... 4081
StructuralOnly ...................................................................................................................... 4081
TemperatureConvergence ..................................................................................................... 4081
TemperatureConvergenceInputValue .................................................................................... 4082
TemperatureConvergenceMinimumReference ....................................................................... 4082
TemperatureConvergenceTolerance ...................................................................................... 4082
TemperatureConvergenceValue ............................................................................................ 4082
ThermalOnly ......................................................................................................................... 4082
TimeIntegration .................................................................................................................... 4082
TimeStep .............................................................................................................................. 4083
TransientApplication ............................................................................................................. 4083

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

TransientApplicationUserDefined .......................................................................................... 4083


TStress .................................................................................................................................. 4083
UpdateViewFactor ................................................................................................................ 4083
UserDefinedFrequencies ....................................................................................................... 4083
UserDefinedFrequencySteps ................................................................................................. 4084
ViewFactorMethod ............................................................................................................... 4084
VoltageConvergence ............................................................................................................. 4084
VoltageConvergenceMinimumReference ............................................................................... 4084
VoltageConvergenceTolerance .............................................................................................. 4084
VoltageConvergenceValue .................................................................................................... 4084
WeakSprings ......................................................................................................................... 4085
GetAMStepType(uint) ........................................................................................................... 4085
GetAutomaticTimeStepping(uint) ......................................................................................... 4085
GetCarryOverTimeStep(uint) ................................................................................................. 4085
GetCreepEffects(uint) ............................................................................................................ 4086
GetCreepLimitRatio(uint) ...................................................................................................... 4086
GetCurrentConvergenceMinimumReference(uint) ................................................................. 4086
GetCurrentConvergenceTolerance(uint) ................................................................................ 4087
GetCurrentConvergenceType(uint) ........................................................................................ 4087
GetCurrentConvergenceValue(uint) ....................................................................................... 4087
GetDefineBy(uint) ................................................................................................................. 4087
GetDisplacementConvergenceMinimumReference(uint) ....................................................... 4088
GetDisplacementConvergenceTolerance(uint) ....................................................................... 4088
GetDisplacementConvergenceType(uint) .............................................................................. 4088
GetDisplacementConvergenceValue(uint) ............................................................................. 4089
GetEmagAMPSConvergenceMinimumReference(uint) ........................................................... 4089
GetEmagAMPSConvergenceTolerance(uint) .......................................................................... 4089
GetEmagAMPSConvergenceType(uint) .................................................................................. 4089
GetEmagAMPSConvergenceValue(uint) ................................................................................. 4090
GetEmagCSGConvergenceMinimumReference(uint) .............................................................. 4090
GetEmagCSGConvergenceTolerance(uint) ............................................................................. 4090
GetEmagCSGConvergenceType(uint) .................................................................................... 4091
GetEmagCSGConvergenceValue(uint) ................................................................................... 4091
GetEnergyConvergenceMinimumReference(uint) .................................................................. 4091
GetEnergyConvergenceTolerance(uint) ................................................................................. 4091
GetEnergyConvergenceType(uint) ......................................................................................... 4092
GetEnergyConvergenceValue(uint) ........................................................................................ 4092
GetForceConvergenceMinimumReference(uint) .................................................................... 4092
GetForceConvergenceTolerance(uint) .................................................................................... 4093
GetForceConvergenceType(uint) ........................................................................................... 4093
GetForceConvergenceValue(uint) .......................................................................................... 4093
GetHeatConvergenceMinimumReference(uint) ..................................................................... 4093
GetHeatConvergenceTolerance(uint) ..................................................................................... 4094
GetHeatConvergenceType(uint) ............................................................................................ 4094
GetHeatConvergenceValue(uint) ........................................................................................... 4094
GetInitialSubsteps(uint) ........................................................................................................ 4095
GetInitialTimeStep(uint) ........................................................................................................ 4095
GetLineSearch(uint) .............................................................................................................. 4095
GetMaximumSubsteps(uint) ................................................................................................. 4095
GetMaximumTimeStep(uint) ................................................................................................. 4096
GetMinimumSubsteps(uint) .................................................................................................. 4096

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

GetMinimumTimeStep(uint) ................................................................................................. 4096


GetMomentConvergenceMinimumReference(uint) ............................................................... 4097
GetMomentConvergenceTolerance(uint) ............................................................................... 4097
GetMomentConvergenceType(uint) ...................................................................................... 4097
GetMomentConvergenceValue(uint) ..................................................................................... 4097
GetNumberOfSubSteps(uint) ................................................................................................ 4098
GetRotationConvergenceMinimumReference(uint) ............................................................... 4098
GetRotationConvergenceTolerance(uint) ............................................................................... 4098
GetRotationConvergenceType(uint) ...................................................................................... 4099
GetRotationConvergenceValue(uint) ..................................................................................... 4099
GetStabilization(uint) ............................................................................................................ 4099
GetStabilizationDampingFactor(uint) .................................................................................... 4099
GetStabilizationEnergyDissipationRatio(uint) ........................................................................ 4100
GetStabilizationFirstSubstepOption(uint) .............................................................................. 4100
GetStabilizationForceLimit(uint) ............................................................................................ 4100
GetStabilizationMethod(uint) ................................................................................................ 4101
GetStepEndTime(uint) .......................................................................................................... 4101
GetStepName(uint) ............................................................................................................... 4101
GetStoreResulsAtValue(uint) ................................................................................................. 4101
GetStoreResultsAt(uint) ......................................................................................................... 4102
GetStructuralOnly(uint) ......................................................................................................... 4102
GetTemperatureConvergenceInputValue(uint) ...................................................................... 4102
GetTemperatureConvergenceMinimumReference(uint) ......................................................... 4103
GetTemperatureConvergenceTolerance(uint) ........................................................................ 4103
GetTemperatureConvergenceType(uint) ................................................................................ 4103
GetTemperatureConvergenceValue(uint) ............................................................................... 4103
GetThermalOnly(uint) ........................................................................................................... 4104
GetTimeIntegration(uint) ...................................................................................................... 4104
GetTimeStep(uint) ................................................................................................................ 4104
GetVoltageConvergenceMinimumReference(uint) ................................................................. 4105
GetVoltageConvergenceTolerance(uint) ................................................................................ 4105
GetVoltageConvergenceType(uint) ........................................................................................ 4105
GetVoltageConvergenceValue(uint) ....................................................................................... 4105
SetAutomaticTimeStepping(uint, AutomaticTimeStepping) ................................................... 4106
SetCarryOverTimeStep(uint, bool) ......................................................................................... 4106
SetChargeConvergenceMinimumReference(uint, Quantity) ................................................... 4106
SetChargeConvergenceTolerance(uint, double) ..................................................................... 4107
SetChargeConvergenceType(uint, ConvergenceToleranceType) ............................................. 4107
SetChargeConvergenceValue(uint, Quantity) ......................................................................... 4107
SetCreepEffects(uint, Creep) .................................................................................................. 4108
SetCreepLimitRatio(uint, double) ........................................................................................... 4108
SetCurrentConvergenceMinimumReference(uint, Quantity) ................................................... 4109
SetCurrentConvergenceTolerance(uint, double) ..................................................................... 4109
SetCurrentConvergenceType(uint, ConvergenceToleranceType) ............................................. 4109
SetCurrentConvergenceValue(uint, Quantity) ......................................................................... 4110
SetDefineBy(uint, TimeStepDefineByType) ............................................................................. 4110
SetDisplacementConvergenceMinimumReference(uint, Quantity) ......................................... 4110
SetDisplacementConvergenceTolerance(uint, double) ........................................................... 4111
SetDisplacementConvergenceType(uint, ConvergenceToleranceType) ................................... 4111
SetDisplacementConvergenceValue(uint, Quantity) ............................................................... 4111
SetEmagAMPSConvergenceMinimumReference(uint, Quantity) ............................................. 4112

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

SetEmagAMPSConvergenceTolerance(uint, double) ............................................................... 4112


SetEmagAMPSConvergenceType(uint, ConvergenceToleranceType) ....................................... 4113
SetEmagAMPSConvergenceValue(uint, Quantity) ................................................................... 4113
SetEmagCSGConvergenceMinimumReference(uint, Quantity) ............................................... 4113
SetEmagCSGConvergenceTolerance(uint, double) ................................................................. 4114
SetEmagCSGConvergenceType(uint, ConvergenceToleranceType) ......................................... 4114
SetEmagCSGConvergenceValue(uint, Quantity) ..................................................................... 4114
SetEnergyConvergenceMinimumReference(uint, Quantity) .................................................... 4115
SetEnergyConvergenceTolerance(uint, double) ...................................................................... 4115
SetEnergyConvergenceType(uint, ConvergenceToleranceType) .............................................. 4115
SetEnergyConvergenceValue(uint, Quantity) .......................................................................... 4116
SetForceConvergenceMinimumReference(uint, Quantity) ...................................................... 4116
SetForceConvergenceTolerance(uint, double) ........................................................................ 4117
SetForceConvergenceType(uint, ConvergenceToleranceType) ................................................ 4117
SetForceConvergenceValue(uint, Quantity) ............................................................................ 4117
SetHeatConvergenceMinimumReference(uint, Quantity) ....................................................... 4118
SetHeatConvergenceTolerance(uint, double) ......................................................................... 4118
SetHeatConvergenceType(uint, ConvergenceToleranceType) ................................................. 4118
SetHeatConvergenceValue(uint, Quantity) ............................................................................. 4119
SetInitialSubsteps(uint, uint) .................................................................................................. 4119
SetInitialTimeStep(uint, Quantity) .......................................................................................... 4119
SetLineSearch(uint, LineSearchType) ..................................................................................... 4120
SetMaximumSubsteps(uint, uint) ........................................................................................... 4120
SetMaximumTimeStep(uint, Quantity) ................................................................................... 4121
SetMinimumSubsteps(uint, uint) ........................................................................................... 4121
SetMinimumTimeStep(uint, Quantity) ................................................................................... 4121
SetMomentConvergenceMinimumReference(uint, Quantity) ................................................. 4122
SetMomentConvergenceTolerance(uint, double) ................................................................... 4122
SetMomentConvergenceType(uint, ConvergenceToleranceType) ........................................... 4122
SetMomentConvergenceValue(uint, Quantity) ....................................................................... 4123
SetNumberOfSubSteps(uint, uint) ......................................................................................... 4123
SetRotationConvergenceMinimumReference(uint, Quantity) ................................................. 4123
SetRotationConvergenceTolerance(uint, double) ................................................................... 4124
SetRotationConvergenceType(uint, ConvergenceToleranceType) ........................................... 4124
SetRotationConvergenceValue(uint, Quantity) ....................................................................... 4125
SetStabilization(uint, StabilizationType) ................................................................................. 4125
SetStabilizationDampingFactor(uint, double) ......................................................................... 4125
SetStabilizationEnergyDissipationRatio(uint, double) ............................................................. 4126
SetStabilizationFirstSubstepOption(uint, StabilizationFirstSubstepOption) ............................. 4126
SetStabilizationForceLimit(uint, double) ................................................................................ 4126
SetStabilizationMethod(uint, StabilizationMethod) ................................................................ 4127
SetStepEndTime(uint, Quantity) ............................................................................................ 4127
SetStepName(uint, string) ..................................................................................................... 4127
SetStoreResulsAtValue(uint, uint) ........................................................................................... 4128
SetStoreResultsAt(uint, TimePointsOptions) ........................................................................... 4128
SetStructuralOnly(uint, bool) ................................................................................................. 4129
SetTemperatureConvergenceInputValue(uint, Quantity) ........................................................ 4129
SetTemperatureConvergenceMinimumReference(uint, Quantity) ........................................... 4129
SetTemperatureConvergenceTolerance(uint, double) ............................................................. 4130
SetTemperatureConvergenceType(uint, ConvergenceToleranceType) ..................................... 4130
SetTemperatureConvergenceValue(uint, NonLinearValueType) .............................................. 4130

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

SetThermalOnly(uint, bool) ................................................................................................... 4131


SetTimeIntegration(uint, bool) .............................................................................................. 4131
SetTimeStep(uint, Quantity) .................................................................................................. 4131
SetVoltageConvergenceMinimumReference(uint, Quantity) ................................................... 4132
SetVoltageConvergenceTolerance(uint, double) ..................................................................... 4132
SetVoltageConvergenceType(uint, ConvergenceToleranceType) ............................................. 4133
SetVoltageConvergenceValue(uint, Quantity) ........................................................................ 4133
EXDAnalysisSettings ................................................................................................................... 4133
ArtificialViscosityForShellsType ............................................................................................. 4139
AutomaticMassScalingType .................................................................................................. 4139
BeamSolutionType ................................................................................................................ 4139
BeamTimeStepSafetyFactor .................................................................................................. 4139
CharZoneDimensionType ...................................................................................................... 4139
CurrentStepNumber ............................................................................................................. 4140
DensityUpdateType .............................................................................................................. 4140
DetonationBurnType ............................................................................................................ 4140
ErosionGeomStrainLimit ....................................................................................................... 4140
ErosionMinElemTimestep ..................................................................................................... 4140
ErosionOnGeomStrainType ................................................................................................... 4140
ErosionOnMaterialFailureType ............................................................................................... 4141
ErosionOnMinElemTimestepType .......................................................................................... 4141
ErosionRetainIntertiaType ..................................................................................................... 4141
EulerBoundLowerX ............................................................................................................... 4141
EulerBoundLowerY ............................................................................................................... 4141
EulerBoundLowerZ ............................................................................................................... 4141
EulerBoundUpperX ............................................................................................................... 4142
EulerBoundUpperY ............................................................................................................... 4142
EulerBoundUpperZ ............................................................................................................... 4142
EulerCellSize ......................................................................................................................... 4142
EulerDisplayBox .................................................................................................................... 4142
EulerDomainType ................................................................................................................. 4142
EulerDomScopeDefType ....................................................................................................... 4143
EulerGradedDefinition .......................................................................................................... 4143
EulerGradeIncrement ............................................................................................................ 4143
EulerGradeNumberOfTimes .................................................................................................. 4143
EulerPropertyDisplayBox ....................................................................................................... 4143
EulerPropertyXmin ............................................................................................................... 4143
EulerPropertyXres ................................................................................................................. 4144
EulerPropertyXsize ................................................................................................................ 4144
EulerPropertyYmin ................................................................................................................ 4144
EulerPropertyYres ................................................................................................................. 4144
EulerPropertyYsize ................................................................................................................ 4144
EulerPropertyZmin ............................................................................................................... 4144
EulerPropertyZres ................................................................................................................. 4145
EulerPropertyZsize ................................................................................................................ 4145
EulerResolutionDefType ........................................................................................................ 4145
EulerSizeDefType .................................................................................................................. 4145
EulerTotalCells ...................................................................................................................... 4145
EulerTrackType ..................................................................................................................... 4145
EulerXDim ............................................................................................................................ 4146
EulerXOrigin ......................................................................................................................... 4146

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

EulerXScaleFactor ................................................................................................................. 4146


EulerXZones ......................................................................................................................... 4146
EulerYDim ............................................................................................................................ 4146
EulerYOrigin ......................................................................................................................... 4146
EulerYScaleFactor ................................................................................................................. 4147
EulerYZones ......................................................................................................................... 4147
EulerZDim ............................................................................................................................ 4147
EulerZOrigin ......................................................................................................................... 4147
EulerZScaleFactor ................................................................................................................. 4147
EulerZZones ......................................................................................................................... 4147
HexIntegrationType .............................................................................................................. 4148
HourglassDampingType ........................................................................................................ 4148
InitialTimeStep ..................................................................................................................... 4148
InternalObject ...................................................................................................................... 4148
LinearArtificialViscosity ......................................................................................................... 4148
LinearViscosityExpansionType ............................................................................................... 4148
LinearViscositySPH ................................................................................................................ 4149
MassScalingMaxElem ............................................................................................................ 4149
MassScalingMaxPart ............................................................................................................. 4149
MassScalingMinTimeStep ..................................................................................................... 4149
MassScalingUpdateFreq ........................................................................................................ 4149
MaximumEnergyError ........................................................................................................... 4149
MaximumTimeStep .............................................................................................................. 4150
MaximumTimeSteps ............................................................................................................. 4150
MaximumVelocity ................................................................................................................. 4150
MinimumStrainCutOff ........................................................................................................... 4150
MinimumTimeStep ............................................................................................................... 4150
MinimumVelocity ................................................................................................................. 4150
NumberOfSteps .................................................................................................................... 4151
OutputContactForcesOnPoints .............................................................................................. 4151
OutputContactForcesOnTime ............................................................................................... 4151
OutputContactForcesOnTimeSteps ....................................................................................... 4151
OutputContactForcesOnType ................................................................................................ 4151
OutputRemapFile ................................................................................................................. 4151
PreferenceType ..................................................................................................................... 4152
PusoCoefficient ..................................................................................................................... 4152
QuadraticArtificialViscosity ................................................................................................... 4152
QuadratricViscositySPH ......................................................................................................... 4152
RadiusCutoff ......................................................................................................................... 4152
ReferenceEnergyTimeStep .................................................................................................... 4152
ResumeFromTimeStep .......................................................................................................... 4153
SavePrintSummaryOnTime ................................................................................................... 4153
SavePrintSummaryOnTimeSteps ........................................................................................... 4153
SavePrintSummaryOnType .................................................................................................... 4153
SaveUserEditOnTime ............................................................................................................ 4153
SaveUserEditOnTimeSteps .................................................................................................... 4153
SaveUserEditOnType ............................................................................................................. 4154
ShellInertiaUpdateType ......................................................................................................... 4154
ShellShearCorrectionFactor ................................................................................................... 4154
ShellSublayers ...................................................................................................................... 4154
ShellThicknessUpdateType .................................................................................................... 4154

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

ShellWarpCorrection ............................................................................................................. 4154


SolverPrecisionType .............................................................................................................. 4155
SolveUnits ............................................................................................................................ 4155
SPHMaxDensityFactor ........................................................................................................... 4155
SPHMinDensityFactor ........................................................................................................... 4155
SphMinTimeStep .................................................................................................................. 4155
SPHNodeDensityCutoffOption .............................................................................................. 4155
StepawareMassScalingType .................................................................................................. 4156
StepawareOutputControlsType ............................................................................................. 4156
StiffnessCoefficient ............................................................................................................... 4156
TetPressureIntegrationType ................................................................................................... 4156
TimeStepSafetyFactor ........................................................................................................... 4156
ViscousCoefficient ................................................................................................................ 4156
ViscousCoefficientFB ............................................................................................................. 4157
getADRConvergenceMethod(int) .......................................................................................... 4157
getADRConvergenceTolerance(int) ........................................................................................ 4157
getADRMaximumIterations(int) ............................................................................................. 4157
GetAutomaticMassScalingType(int) ....................................................................................... 4158
GetLoadStepType(int) ........................................................................................................... 4158
GetMassScalingMinTimeStep(int) .......................................................................................... 4158
GetSaveProbeDataOnTime(int) ............................................................................................. 4158
GetSaveProbeDataOnTimeSteps(int) ..................................................................................... 4159
GetSaveProbeDataOnType(int) .............................................................................................. 4159
GetSaveRestartsOnPoints(int) ................................................................................................ 4159
GetSaveRestartsOnTime(int) ................................................................................................. 4160
GetSaveRestartsOnTimeSteps(int) ......................................................................................... 4160
GetSaveRestartsOnType(int) .................................................................................................. 4160
GetSaveResultsOnPoints(int) ................................................................................................. 4160
GetSaveResultsOnTime(int) ................................................................................................... 4161
GetSaveResultsOnTimeSteps(int) .......................................................................................... 4161
GetSaveResultsOnType(int) ................................................................................................... 4161
GetStaticDamping(int) .......................................................................................................... 4162
GetStepEndTime(int) ............................................................................................................ 4162
setADRConvergenceMethod(int, EXDADRConvergenceMethod) ............................................ 4162
setADRConvergenceTolerance(int, double) ............................................................................ 4162
setADRMaximumIterations(int, int) ........................................................................................ 4163
SetAutomaticMassScalingType(int, EXDAutomaticMassScalingType) ...................................... 4163
SetLoadStepType(int, EXDLoadStepType) .............................................................................. 4164
SetMassScalingMinTimeStep(int, Quantity) ............................................................................ 4164
SetSaveProbeDataOnTime(int, Quantity) ............................................................................... 4164
SetSaveProbeDataOnTimeSteps(int, int) ................................................................................ 4165
SetSaveProbeDataOnType(int, EXDSaveProbeDataOnType) ................................................... 4165
SetSaveRestartsOnPoints(int, int) ........................................................................................... 4165
SetSaveRestartsOnTime(int, Quantity) ................................................................................... 4166
SetSaveRestartsOnTimeSteps(int, int) .................................................................................... 4166
SetSaveRestartsOnType(int, EXDSaveRestartsOnType) ........................................................... 4166
SetSaveResultsOnPoints(int, int) ............................................................................................ 4167
SetSaveResultsOnTime(int, Quantity) ..................................................................................... 4167
SetSaveResultsOnTimeSteps(int, int) ...................................................................................... 4168
SetSaveResultsOnType(int, EXDSaveResultsOnType) .............................................................. 4168
SetStaticDamping(int, double) .............................................................................................. 4168

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

SetStepEndTime(int, Quantity) .............................................................................................. 4169


RBDAnalysisSettings ................................................................................................................... 4169
AssemblyType ...................................................................................................................... 4172
ConstraintEquationResidualTolerance ................................................................................... 4172
ConstraintEquationResidualToleranceValue ........................................................................... 4172
CorrectionType ..................................................................................................................... 4172
CurrentStepNumber ............................................................................................................. 4172
DropoffTolerance .................................................................................................................. 4173
EnergyAccuracyTolerance ..................................................................................................... 4173
EnergyAccuracyToleranceValue ............................................................................................. 4173
ForceResidualTolerance ......................................................................................................... 4173
ForceResidualToleranceValue ................................................................................................ 4173
InternalObject ...................................................................................................................... 4173
NumberOfSteps .................................................................................................................... 4174
NumericalDampingTolerance ................................................................................................ 4174
NumericalDampingValue ...................................................................................................... 4174
PerformStaticAnalysis ........................................................................................................... 4174
PositionCorrection ................................................................................................................ 4174
RelativeAssemblyTolerance ................................................................................................... 4174
RelativeAssemblyToleranceValue ........................................................................................... 4175
TimeIntegrationType ............................................................................................................ 4175
VelocityConstraintEquationResidualTolerance ....................................................................... 4175
VelocityConstraintEquationResidualToleranceValue ............................................................... 4175
VelocityCorrection ................................................................................................................ 4175
GetAutomaticTimeStepping(int) ........................................................................................... 4175
GetCarryOverTimeStep(int) ................................................................................................... 4176
GetInitialTimeStep(int) .......................................................................................................... 4176
GetMaximumTimeStep(int) ................................................................................................... 4176
GetMinimumTimeStep(int) ................................................................................................... 4177
GetStepEndTime(int) ............................................................................................................ 4177
GetStoreResultAt(int) ............................................................................................................ 4177
GetStoreResultAtValue(int) .................................................................................................... 4177
GetTimeStep(int) .................................................................................................................. 4178
SetAutomaticTimeStepping(int, AutomaticTimeStepping) ..................................................... 4178
SetCarryOverTimeStep(int, bool) ........................................................................................... 4178
SetInitialTimeStep(int, Quantity) ............................................................................................ 4179
SetMaximumTimeStep(int, Quantity) ..................................................................................... 4179
SetMinimumTimeStep(int, Quantity) ..................................................................................... 4179
SetStepEndTime(int, Quantity) .............................................................................................. 4180
SetStoreResultAt(int, TimePointsOptions) .............................................................................. 4180
SetStoreResultAtValue(int, int) ............................................................................................... 4181
SetTimeStep(int, Quantity) .................................................................................................... 4181
TopoOptAnalysisSettings ............................................................................................................ 4181
Algorithm ............................................................................................................................. 4183
ConvergenceAccuracy .......................................................................................................... 4183
DataModelObjectCategory ................................................................................................... 4183
DeleteUnneededFiles ............................................................................................................ 4183
ExportDesignProperties ........................................................................................................ 4183
ExportDesignPropertiesFileFormat ........................................................................................ 4184
ExportKnockdownFilePath .................................................................................................... 4184
Filter ..................................................................................................................................... 4184

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

FutureAnalysis ...................................................................................................................... 4184


InternalObject ...................................................................................................................... 4184
MaximumNumberOfIterations .............................................................................................. 4184
MaxNumOfIntermediateFiles ................................................................................................ 4185
MinimumNormalizedDensity ................................................................................................ 4185
MultiOptimTypeStrategy ....................................................................................................... 4185
OptimizationOutputLog ........................................................................................................ 4185
PenaltyFactor ........................................................................................................................ 4185
RegionOfAMOverhangConstraint .......................................................................................... 4185
RegionOfManufacturingConstraint ....................................................................................... 4186
RegionOfMinMemberSize ..................................................................................................... 4186
SaveMAPDLDB ...................................................................................................................... 4186
SolverType ............................................................................................................................ 4186
SolverUnits ........................................................................................................................... 4186
SolverUnitSystem ................................................................................................................. 4186
StoreResultsAt ...................................................................................................................... 4187
StoreResultsAtValue .............................................................................................................. 4187
TopoOptInitialDensity ........................................................................................................... 4187
Ansys.ACT.Automation.Mechanical.AdditiveManufacturing Namespace ..................................... 4189
AMBuildSettings ......................................................................................................................... 4190
Absorptivity .......................................................................................................................... 4192
AdditiveProcess .................................................................................................................... 4192
ASCParallel ........................................................................................................................... 4192
ASCPerpendicular ................................................................................................................. 4192
ASCVertical ........................................................................................................................... 4193
BeamDiameter ...................................................................................................................... 4193
BeamPower .......................................................................................................................... 4193
BuildGasConvectionCoefficient ............................................................................................. 4193
BuildGasOrPowderTemperatureType ..................................................................................... 4193
BuildGasTemperature ........................................................................................................... 4193
BuildMachineType ................................................................................................................ 4194
BuildPowderConvectionCoefficient ....................................................................................... 4194
BuildPowderTemperature ..................................................................................................... 4194
Children ............................................................................................................................... 4194
Comments ............................................................................................................................ 4194
CooldownGasConvectionCoefficient ..................................................................................... 4194
CooldownGasOrPowderTemperatureType ............................................................................. 4195
CooldownGasTemperature ................................................................................................... 4195
CooldownPowderConvectionCoefficient ............................................................................... 4195
CooldownPowderTemperature ............................................................................................. 4195
DataModelObjectCategory ................................................................................................... 4195
DepositionThickness ............................................................................................................. 4195
DwellTime ............................................................................................................................ 4196
DwellTimeMultiple ............................................................................................................... 4196
Figures ................................................................................................................................. 4196
GeneratedLayerRotationAngle .............................................................................................. 4196
GeneratedStartLayerAngle .................................................................................................... 4196
HatchSpacing ....................................................................................................................... 4196
HeatingDuration ................................................................................................................... 4197
HeatingMethod .................................................................................................................... 4197
Images ................................................................................................................................. 4197

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

InherentStrain ....................................................................................................................... 4197


InherentStrainDefinition ....................................................................................................... 4197
InternalObject ...................................................................................................................... 4197
LayerHeightType ................................................................................................................... 4198
LayerHeightValue ................................................................................................................. 4198
MachineLearningModel ........................................................................................................ 4198
NumberOfHeatSources ......................................................................................................... 4198
PowderPropertyFactor .......................................................................................................... 4198
PreheatTemperature ............................................................................................................. 4198
RoomTemperature ................................................................................................................ 4199
ScanPatternBuildFilePath ...................................................................................................... 4199
ScanPatternDefinition ........................................................................................................... 4199
ScanSpeed ............................................................................................................................ 4199
ScanStripeWidth ................................................................................................................... 4199
StrainScalingFactor ............................................................................................................... 4199
StrainScalingFactorX ............................................................................................................. 4200
StrainScalingFactorY ............................................................................................................. 4200
StrainScalingFactorZ ............................................................................................................. 4200
ThermalStrainMaterialModel ***OBSOLETE*** ThermalStrainMaterialModel is deprecated, please
use MachineLearningModel instead. ..................................................................................... 4200
ThermalStrainMethod ........................................................................................................... 4200
ThermalStrainScalingFactor ................................................................................................... 4200
AddComment() ..................................................................................................................... 4201
AddFigure() .......................................................................................................................... 4201
AddImage(string) .................................................................................................................. 4201
Delete() ................................................................................................................................ 4201
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 4201
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 4202
LoadBuildSettings(string) ...................................................................................................... 4202
ResetToDefault() ................................................................................................................... 4203
SaveBuildSettings(string) ...................................................................................................... 4203
AMProcess .................................................................................................................................. 4203
BaseGeometry ...................................................................................................................... 4204
BuildGeometry ***OBSOLETE*** BuildGeometry is deprecated, please use PartGeometry in-
stead. ................................................................................................................................... 4205
Children ............................................................................................................................... 4205
Comments ............................................................................................................................ 4205
DataModelObjectCategory ................................................................................................... 4205
ElementSize .......................................................................................................................... 4205
Figures ................................................................................................................................. 4205
Images ................................................................................................................................. 4206
InternalObject ...................................................................................................................... 4206
LayerHeight .......................................................................................................................... 4206
LengthUnits .......................................................................................................................... 4206
MeshUsingVoxelization ......................................................................................................... 4206
NonlinearEffects ................................................................................................................... 4206
PartGeometry ....................................................................................................................... 4207
SubsampleRate ..................................................................................................................... 4207
WallThickness ....................................................................................................................... 4207
ZLocationAtTopOfBase ......................................................................................................... 4207
AddCartesianMesh() ............................................................................................................. 4207

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

AddComment() ..................................................................................................................... 4207


AddFigure() .......................................................................................................................... 4208
AddGeneratedAMSupport() .................................................................................................. 4208
AddImage(string) .................................................................................................................. 4208
AddPredefinedAMSupport() .................................................................................................. 4208
AddSTLAMSupport() ............................................................................................................. 4208
AddSupportGroup() .............................................................................................................. 4209
CleanAMStrains() .................................................................................................................. 4209
CreateAMBondConnections() ................................................................................................ 4209
CreateBuildToBaseContact() .................................................................................................. 4209
Delete() ................................................................................................................................ 4209
GenerateAMStrains() ***OBSOLETE*** The GenerateAMStrains method is no longer supporetd
since AM strains are generated during solve. ......................................................................... 4209
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 4210
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 4210
GetSequence(Analysis) ......................................................................................................... 4210
HasAMStrains() ***OBSOLETE*** The HasAMStrains property is no longer supported since AM
strains are generated during solve. ........................................................................................ 4211
ResetAllSequences() .............................................................................................................. 4211
AMSupport ................................................................................................................................. 4211
Children ............................................................................................................................... 4212
Comments ............................................................................................................................ 4212
DataModelObjectCategory ................................................................................................... 4213
DensityMultiple .................................................................................................................... 4213
ElasticModulusMultipleInX .................................................................................................... 4213
ElasticModulusMultipleInY .................................................................................................... 4213
ElasticModulusMultipleInZ .................................................................................................... 4213
Figures ................................................................................................................................. 4213
Images ................................................................................................................................. 4214
InternalObject ...................................................................................................................... 4214
MaterialMultiplier ................................................................................................................. 4214
MultiplierEntry ...................................................................................................................... 4214
ShearModulusMultipleInXY ................................................................................................... 4214
ShearModulusMultipleInXZ ................................................................................................... 4214
ShearModulusMultipleInYZ ................................................................................................... 4215
SupportType ......................................................................................................................... 4215
ThermalConductivityMultipleInX ........................................................................................... 4215
ThermalConductivityMultipleInY ........................................................................................... 4215
ThermalConductivityMultipleInZ ........................................................................................... 4215
Volume ................................................................................................................................. 4215
WallSpacing .......................................................................................................................... 4216
WallThickness ....................................................................................................................... 4216
AddCommandSnippet() ........................................................................................................ 4216
AddComment() ..................................................................................................................... 4216
AddFigure() .......................................................................................................................... 4216
AddImage(string) .................................................................................................................. 4216
Delete() ................................................................................................................................ 4217
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 4217
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 4217
AMSupportGroup ....................................................................................................................... 4218
Children ............................................................................................................................... 4219

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

Comments ............................................................................................................................ 4219


DataModelObjectCategory ................................................................................................... 4219
DetectAboveZLocation ......................................................................................................... 4219
Figures ................................................................................................................................. 4219
GenerateOnRemesh .............................................................................................................. 4219
HangAngle ........................................................................................................................... 4220
Images ................................................................................................................................. 4220
InternalObject ...................................................................................................................... 4220
Location ............................................................................................................................... 4220
OutputType .......................................................................................................................... 4220
AddComment() ..................................................................................................................... 4220
AddFigure() .......................................................................................................................... 4221
AddGeneratedAMSupport() .................................................................................................. 4221
AddImage(string) .................................................................................................................. 4221
AddPredefinedAMSupport() .................................................................................................. 4221
AddSTLAMSupport() ............................................................................................................. 4221
Delete() ................................................................................................................................ 4222
DetectSupportFaces() ........................................................................................................... 4222
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 4222
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 4222
PromoteToNamedSelection() ................................................................................................ 4223
AMSupportRemovalSequence .................................................................................................... 4223
Count ................................................................................................................................... 4224
Add(IAMProcessStep) ............................................................................................................ 4224
Contains(IAMProcessStep) .................................................................................................... 4224
IndexOf(IAMProcessStep) ...................................................................................................... 4225
Insert(int, IAMProcessStep) .................................................................................................... 4225
RemoveAt(int) ...................................................................................................................... 4225
Swap(IAMProcessStep, IAMProcessStep) ................................................................................ 4226
Swap(int, int) ......................................................................................................................... 4226
BaseRemoval .............................................................................................................................. 4227
BaseUnboltStep .......................................................................................................................... 4227
BuildStep .................................................................................................................................... 4227
CooldownStep ............................................................................................................................ 4227
GeneratedAMSupport ................................................................................................................. 4227
DataModelObjectCategory ................................................................................................... 4229
InternalObject ...................................................................................................................... 4229
Location ............................................................................................................................... 4229
Mode .................................................................................................................................... 4230
ClearGeneratedData() ........................................................................................................... 4230
CreateNamedSelectionOfGeneratedElements() ..................................................................... 4230
GenerateSupportBodies(Progress) ........................................................................................ 4230
GetGeneratedBody() ............................................................................................................. 4230
HeatTreatmentStep ..................................................................................................................... 4231
IAMProcessStep .......................................................................................................................... 4231
ProcessStepType ................................................................................................................... 4231
PredefinedAMSupport ................................................................................................................ 4231
DataModelObjectCategory ................................................................................................... 4233
InternalObject ...................................................................................................................... 4233
Location ............................................................................................................................... 4233
Suppressed ........................................................................................................................... 4233

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

STLAMSupport ........................................................................................................................... 4233


DataModelObjectCategory ................................................................................................... 4236
ElementSize .......................................................................................................................... 4236
Filename .............................................................................................................................. 4236
GeometrySelection ............................................................................................................... 4236
InternalObject ...................................................................................................................... 4236
LengthUnits .......................................................................................................................... 4237
Source .................................................................................................................................. 4237
STL ....................................................................................................................................... 4237
STLSupportType ................................................................................................................... 4237
STLSupportView ................................................................................................................... 4237
StlWallThickness ................................................................................................................... 4237
SubsampleRate ..................................................................................................................... 4238
VoxelSize ***OBSOLETE*** Use 'ElementSize' property instead. .............................................. 4238
ClearGeneratedData() ........................................................................................................... 4238
CreateNamedSelectionOfExternalElementFaces() .................................................................. 4238
CreateNamedSelectionOfGeneratedElements() ..................................................................... 4238
ExportStl(string, Progress) ..................................................................................................... 4238
GenerateSupportBodies(Progress) ........................................................................................ 4239
GetGeneratedBody() ............................................................................................................. 4239
ImportSTL() .......................................................................................................................... 4239
SupportRemoval ......................................................................................................................... 4239
UserStep ..................................................................................................................................... 4240
Ansys.Mechanical.DataModel.Utilities Namespace ....................................................................... 4241
BeamCoordinateSystem .............................................................................................................. 4241
CenterOfGravityCoordinateSystem .............................................................................................. 4241
RigidBodyTransformationMatrix .................................................................................................. 4242
Data ..................................................................................................................................... 4242
S ........................................................................................................................................... 4243
T_x ....................................................................................................................................... 4243
T_y ....................................................................................................................................... 4243
T_z ....................................................................................................................................... 4243
tau_x .................................................................................................................................... 4243
tau_y .................................................................................................................................... 4243
tau_z .................................................................................................................................... 4244
X_x ....................................................................................................................................... 4244
X_y ....................................................................................................................................... 4244
X_z ....................................................................................................................................... 4244
Y_x ....................................................................................................................................... 4244
Y_y ....................................................................................................................................... 4244
Y_z ....................................................................................................................................... 4245
Z_x ....................................................................................................................................... 4245
Z_y ....................................................................................................................................... 4245
Z_z ....................................................................................................................................... 4245
Ansys.Mechanical.DataModel.Utilities.TabularData Namespace .................................................. 4247
DataSeriesAdapter ...................................................................................................................... 4247
DataSeriesAdapter(object, bool) ............................................................................................ 4248
PropertyChanged ................................................................................................................. 4248
Count ................................................................................................................................... 4248
DataType .............................................................................................................................. 4249
IsFixedSize ............................................................................................................................ 4249

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

IsReadOnly ........................................................................................................................... 4249


IsSynchronized ..................................................................................................................... 4249
Item(int) ............................................................................................................................... 4249
Name ................................................................................................................................... 4249
QuantityName ...................................................................................................................... 4250
SyncRoot .............................................................................................................................. 4250
Unit ...................................................................................................................................... 4250
Values ................................................................................................................................... 4250
Add(object) .......................................................................................................................... 4250
Clear() ................................................................................................................................... 4251
Contains(object) ................................................................................................................... 4251
CopyTo(Array, int) .................................................................................................................. 4251
GetEnumerator() ................................................................................................................... 4251
IndexOf(object) .................................................................................................................... 4252
Insert(int, object) ................................................................................................................... 4252
Remove(object) .................................................................................................................... 4252
RemoveAt(int) ...................................................................................................................... 4253
ReadOnlyDataSeriesAdapter ....................................................................................................... 4253
ReadOnlyDataSeriesAdapter(object) ..................................................................................... 4253
Count ................................................................................................................................... 4254
DataType .............................................................................................................................. 4254
Item(int) ............................................................................................................................... 4254
Name ................................................................................................................................... 4254
QuantityName ...................................................................................................................... 4254
Unit ...................................................................................................................................... 4255
Values ................................................................................................................................... 4255
GetEnumerator() ................................................................................................................... 4255
ReadOnlyDataTableAdapter ........................................................................................................ 4255
ReadOnlyDataTableAdapter(IDataTable) ................................................................................ 4256
ColumnNames ...................................................................................................................... 4256
Columns ............................................................................................................................... 4256
Count ................................................................................................................................... 4256
Item(object) .......................................................................................................................... 4257
Metadata .............................................................................................................................. 4257
Name ................................................................................................................................... 4257
RowCount ............................................................................................................................ 4257
GetEnumerator() ................................................................................................................... 4257
GetRow(int) .......................................................................................................................... 4258
Ansys.Mechanical.DataModel.SolverData Namespace .................................................................. 4259
MAPDLAMSupportData .............................................................................................................. 4260
MaterialIds ............................................................................................................................ 4260
RealConstantId ..................................................................................................................... 4260
MAPDLBeamData ....................................................................................................................... 4260
MaterialId ............................................................................................................................. 4260
MAPDLBearingData .................................................................................................................... 4261
MAPDLBodyData ........................................................................................................................ 4261
ElementTypeIds .................................................................................................................... 4261
MaterialIds ............................................................................................................................ 4261
RealConstantId ..................................................................................................................... 4261
MAPDLBoltPretensionData .......................................................................................................... 4262
PretensionNodeIds ............................................................................................................... 4262

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

RealConstantIds .................................................................................................................... 4262


MAPDLContactData .................................................................................................................... 4262
SourceId ............................................................................................................................... 4263
TargetId ................................................................................................................................ 4263
MAPDLCoordinateSystemData .................................................................................................... 4263
SystemId .............................................................................................................................. 4263
MAPDLImportedSurfaceLoadData ............................................................................................... 4263
LoadTypes ............................................................................................................................ 4264
GetSurfaceEffectElementTypeId(ImportedSurfaceLoadType) ................................................. 4264
MAPDLJointData ........................................................................................................................ 4264
MAPDLLayeredSectionData ........................................................................................................ 4264
SectionId .............................................................................................................................. 4265
MAPDLRemotePointData ............................................................................................................ 4265
NodeId ................................................................................................................................. 4265
MAPDLSolverData ...................................................................................................................... 4265
MaxElementId ...................................................................................................................... 4266
MaxElementTypeId ............................................................................................................... 4266
MaxNodeId ........................................................................................................................... 4266
ElementIdsByMaterialId(string) ............................................................................................. 4266
NodeIdsByMaterialId(string) .................................................................................................. 4267
MAPDLSpringData ...................................................................................................................... 4267
MAPDLSurfaceCoatingData ......................................................................................................... 4267
MaterialId ............................................................................................................................. 4267
MAPDLSurfaceLoadData ............................................................................................................. 4268
SurfaceEffectElementTypeId ................................................................................................. 4268
SolverData .................................................................................................................................. 4268
GetObjectData(IDataModelObject) ....................................................................................... 4268
Ansys.Mechanical.DataModel.Results Namespace ........................................................................ 4269
ResultDataTable .......................................................................................................................... 4269
Count ................................................................................................................................... 4269
Item(string) .......................................................................................................................... 4270
Keys ..................................................................................................................................... 4270
Values ................................................................................................................................... 4270
ContainsKey(string) ............................................................................................................... 4270
ResultVariable ............................................................................................................................. 4270
Count ................................................................................................................................... 4271
Item(int) ............................................................................................................................... 4271
Ansys.Mechanical.DataModel.MechanicalEnums.FluidPenetrationPressure Namespace ............ 4273
CriterionDefinedByType .............................................................................................................. 4273
FluidPathType ............................................................................................................................. 4273
GraphDisplay .............................................................................................................................. 4274
PenetrationPressureUpdateType ................................................................................................. 4274
StartPointScopingType ............................................................................................................... 4274
Ansys.Mechanical.DataModel.MechanicalEnums.CrackInitiation Namespace ............................. 4277
CrackCenter ................................................................................................................................ 4277
CrackOrientation ........................................................................................................................ 4277
CrackShape ................................................................................................................................ 4278
Ansys.Mechanical.DataModel.MechanicalEnums.Common Namespace ....................................... 4279
PathType .................................................................................................................................... 4279
Ansys.Mechanical.DataModel.MechanicalEnums.SolutionCombination Namespace .................. 4281
EnvelopeType ............................................................................................................................. 4281

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

Type ........................................................................................................................................... 4281


Ansys.Mechanical.DataModel.MechanicalEnums.MeshWorkflow Namespace ............................. 4283
CheckpointDefinitionType .......................................................................................................... 4284
ControlDataDefinedByType ......................................................................................................... 4284
ControlType ................................................................................................................................ 4285
DataTransferType ........................................................................................................................ 4288
HemisphereCenterDefinitionType ............................................................................................... 4289
HemisphereOrientationDefinitionType ........................................................................................ 4289
MaterialPointDefineByType ......................................................................................................... 4290
MaterialPointType ....................................................................................................................... 4290
OperationType ............................................................................................................................ 4290
OutcomeType ............................................................................................................................. 4292
ScopeDefinedByType .................................................................................................................. 4293
ScopeType .................................................................................................................................. 4293
SettingsType ............................................................................................................................... 4293
SphereCenterDefinitionType ....................................................................................................... 4294
SurfaceMeshType ....................................................................................................................... 4294
VolumeMeshType ....................................................................................................................... 4294
WorkflowType ............................................................................................................................. 4295
WrapperRegionType ................................................................................................................... 4296
Ansys.Mechanical.DataModel.MechanicalEnums.Table Namespace ............................................. 4297
ImportFormat ............................................................................................................................. 4297
TableRefreshImportOn ................................................................................................................ 4297
VariableClassification .................................................................................................................. 4298
VariableType ............................................................................................................................... 4298
Ansys.Mechanical.DataModel.MechanicalEnums.Materials Namespace ...................................... 4301
ExistingMaterialOperation ........................................................................................................... 4301
IdentifierType ............................................................................................................................. 4302
ImportFormat ............................................................................................................................. 4302
Ansys.Mechanical.DataModel.MechanicalEnums.CompositeFailure Namespace ......................... 4303
FailureDimension ........................................................................................................................ 4303
LaRCFormulation ........................................................................................................................ 4303
PuckFormulation ........................................................................................................................ 4303
Ansys.Mechanical.DataModel.MechanicalEnums.Graphics Namespace ....................................... 4305
CappingType .............................................................................................................................. 4305
ContourView .............................................................................................................................. 4305
DeformationScaling .................................................................................................................... 4306
ExtraModelDisplay ...................................................................................................................... 4306
GeometryView ............................................................................................................................ 4306
ScopingDisplay ........................................................................................................................... 4307
Ansys.Mechanical.DataModel.MechanicalEnums.ExternalData Namespace ................................ 4309
ImportFormat ............................................................................................................................. 4309
LengthUnit ................................................................................................................................. 4309
VariableType ............................................................................................................................... 4310
Ansys.Mechanical.DataModel.MechanicalEnums.CondensedParts Namespace ........................... 4313
ExportFormat ............................................................................................................................. 4313
Ansys.Mechanical.DataModel.MechanicalEnums.BoundaryConditions Namespace ................... 4315
DataRepresentation .................................................................................................................... 4315
Ansys.Mechanical.DataModel.MechanicalEnums.Substructure Namespace ................................ 4317
ExportFormat ............................................................................................................................. 4317
Ansys.Mechanical.DataModel.Enums Namespace ......................................................................... 4319

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

ActiveOrInactive ......................................................................................................................... 4335


AggressiveRemeshingType ......................................................................................................... 4335
AlgorithmType ............................................................................................................................ 4336
AMBaseRemovalType .................................................................................................................. 4336
AMBuildMachineType ................................................................................................................. 4336
AMCooldownTimeType ............................................................................................................... 4337
AMHeatingDurationType ............................................................................................................ 4337
AMHeatingMethod ..................................................................................................................... 4337
AMInherentStrainDefinition ........................................................................................................ 4338
AMLayerHeightType ................................................................................................................... 4338
AMMachineLearningModel ......................................................................................................... 4338
AMMultiplierEntryType ............................................................................................................... 4339
AMProcessSettingsType .............................................................................................................. 4339
AMProcessSimulationType .......................................................................................................... 4339
AMProcessStepType .................................................................................................................... 4340
AMProcessType .......................................................................................................................... 4340
AMReferenceTemperatureType ................................................................................................... 4340
AMRelaxationTemperatureType .................................................................................................. 4341
AMScanPatternDefinition ............................................................................................................ 4341
AMStlSource ............................................................................................................................... 4341
AMSupportGroupOutputType ..................................................................................................... 4341
AMSupportSTLType .................................................................................................................... 4342
AMSupportType ......................................................................................................................... 4342
AMThermalStrainMaterialModel .................................................................................................. 4342
AMThermalStrainMethod ............................................................................................................ 4343
AnalysisType ............................................................................................................................... 4343
AnalysisTypeDimensionEnum ..................................................................................................... 4344
ApplicationSourceEnum ............................................................................................................. 4344
ApplicationType ......................................................................................................................... 4344
ArtificiallyMatchedLayers ............................................................................................................ 4344
AutoDetectionType ..................................................................................................................... 4345
AutomaticNodeMovementMethod ............................................................................................. 4345
AutomaticOrManual ................................................................................................................... 4345
AutomaticTimeStepping ............................................................................................................. 4346
AxisSelectionType ....................................................................................................................... 4346
BaseResultType ........................................................................................................................... 4346
BeamBeamContactDetectionType ***OBSOLETE*** Use 'LineLineContactDetectionType' property
instead. ....................................................................................................................................... 4347
BeamBeamModel ....................................................................................................................... 4348
BeamEndReleaseBehavior ........................................................................................................... 4348
BeamOffsetType ......................................................................................................................... 4348
BeamSolutionType ...................................................................................................................... 4348
BeamToolStressResultType .......................................................................................................... 4349
BodyInteractionFormulation ....................................................................................................... 4349
BodyStackingType ...................................................................................................................... 4349
BodyTreatment ........................................................................................................................... 4350
BodyType ................................................................................................................................... 4350
BoltLoadDefineBy ....................................................................................................................... 4350
BoltResultType ............................................................................................................................ 4351
BondedBreakableType ................................................................................................................ 4351
BoundaryConditionAlongFiber ................................................................................................... 4351

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

BoundaryConditionForRotation .................................................................................................. 4352


BoundaryConditionSelectionType ............................................................................................... 4352
BoundaryConditionType ............................................................................................................. 4352
BrickIntegrationScheme .............................................................................................................. 4353
CacheResultsInMemory .............................................................................................................. 4353
CalculateParticipationFactorResult .............................................................................................. 4353
CameraAxisType ......................................................................................................................... 4354
CampbellDiagramRotationalVelocitySelectionType ..................................................................... 4354
ChartAxisScaleType ..................................................................................................................... 4355
ChartDimensions ........................................................................................................................ 4355
ChartGridlines ............................................................................................................................ 4355
ChartModalType ......................................................................................................................... 4356
ChartPlotStyle ............................................................................................................................. 4356
ChartReportType ........................................................................................................................ 4356
ChartResultType ......................................................................................................................... 4356
ChartScale .................................................................................................................................. 4357
CombineRestartFilesType ............................................................................................................ 4357
CommandEditorTarget ................................................................................................................ 4358
ComparePartsOnUpdateType ...................................................................................................... 4358
ComparePartsToleranceType ....................................................................................................... 4358
CondensedPartCMSAttachmentMethod ...................................................................................... 4359
CondensedPartExpansionType .................................................................................................... 4359
CondensedPartFileFormat ........................................................................................................... 4359
CondensedPartInterfaceMethod ................................................................................................. 4360
CondensedPartInterfaceType ...................................................................................................... 4360
CondensedPartKeepFilesFor ........................................................................................................ 4360
CondensedPartLumpedMassFormulation .................................................................................... 4361
CondensedPartPhysics ................................................................................................................ 4361
CondensedPartPointMassTreatment ............................................................................................ 4361
CondensedPartReductionMethod ............................................................................................... 4362
ConnectionCreationMethod ....................................................................................................... 4362
ConnectionOptions .................................................................................................................... 4362
ConnectionScopingType ............................................................................................................. 4363
ConstantDampingType ............................................................................................................... 4363
ContactBehavior ......................................................................................................................... 4363
ContactBoltThreadHand ............................................................................................................. 4363
ContactBoltThreadType .............................................................................................................. 4364
ContactConstraintType ............................................................................................................... 4364
ContactCorrection ...................................................................................................................... 4364
ContactDetection ....................................................................................................................... 4365
ContactDetectionPoint ............................................................................................................... 4365
ContactEdgeEdgeOption ............................................................................................................ 4365
ContactElasticSlipToleranceType ................................................................................................. 4366
ContactFaceEdgeOption ............................................................................................................. 4366
ContactFaceEdgePriority ............................................................................................................. 4366
ContactForceType ....................................................................................................................... 4367
ContactFormulation .................................................................................................................... 4367
ContactGroupingType ................................................................................................................ 4367
ContactInitialEffect ..................................................................................................................... 4368
ContactOrientation ..................................................................................................................... 4368
ContactPenetrationToleranceType ............................................................................................... 4369

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

ContactPinballType ..................................................................................................................... 4369


ContactResultType ...................................................................................................................... 4369
ContactScopingType ................................................................................................................... 4370
ContactSearchingType ................................................................................................................ 4370
ContactSideScopingType ............................................................................................................ 4370
ContactSmallSlidingType ............................................................................................................ 4371
ContactSplitType ........................................................................................................................ 4371
ContactSummaryType ................................................................................................................ 4371
ContactTimeStepControls ........................................................................................................... 4371
ContactToleranceType ................................................................................................................ 4372
ContactTrimType ........................................................................................................................ 4372
ContactType ............................................................................................................................... 4372
ConvectionTableSelection ........................................................................................................... 4373
ConvergenceControlType ............................................................................................................ 4373
ConvergenceToleranceType ........................................................................................................ 4374
ConvergenceType ....................................................................................................................... 4374
CoordinateSystemAlignmentType ............................................................................................... 4374
CoordinateSystemAxisType ......................................................................................................... 4375
CoordinateSystemBehavior ......................................................................................................... 4375
CoordinateSystemType ............................................................................................................... 4375
CoreResultType ........................................................................................................................... 4376
CoriolisEffectType ....................................................................................................................... 4376
CouplingConditionDOFType ....................................................................................................... 4376
CrackGrowthIncrementType ....................................................................................................... 4377
CrackGrowthMeshCoarsening ..................................................................................................... 4377
CrackGrowthMethodology .......................................................................................................... 4377
CrackGrowthOption .................................................................................................................... 4378
CrackMeshMethod ...................................................................................................................... 4378
CrackSelectionModeType ............................................................................................................ 4378
CrackShapeType ......................................................................................................................... 4378
CrackSourceType ........................................................................................................................ 4379
CrackSurfaceLoadApplyTo .......................................................................................................... 4379
Creep ......................................................................................................................................... 4380
CriterionFrequencyRangeType .................................................................................................... 4380
CrossSectionType ....................................................................................................................... 4380
CyclicHarmonicIndex .................................................................................................................. 4381
CylindricalFacesOption ............................................................................................................... 4381
DamageResultType ..................................................................................................................... 4381
DampingDefineBy ...................................................................................................................... 4382
DampingType ............................................................................................................................. 4382
DataImportStatus ....................................................................................................................... 4382
DataModelObjectCategory ......................................................................................................... 4383
DataTypeOptions ........................................................................................................................ 4402
DBWeightingType ....................................................................................................................... 4402
DecompositionType .................................................................................................................... 4402
DefaultShellMesherType ............................................................................................................. 4403
DeformationType ***OBSOLETE*** Use 'TotalOrDirectional' property instead. .............................. 4403
DelaminationFailureCriteriaOption .............................................................................................. 4403
DelaminationGenerationMethod ................................................................................................ 4404
DelaminationMethod .................................................................................................................. 4404
DelaminationType ...................................................................................................................... 4404

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

DiagonalOrConsistent ................................................................................................................. 4405


DistributedMassInputType .......................................................................................................... 4405
DpfEvaluationType ..................................................................................................................... 4405
DropDirection ............................................................................................................................. 4405
DropTestDefineBy ....................................................................................................................... 4406
DSCampbellAxisRange ................................................................................................................ 4406
DSCampbellYAxisDataType ......................................................................................................... 4406
DSRBDContactDetection ............................................................................................................. 4407
DynamicRelaxationBehaviorType ................................................................................................ 4407
ECADFidelity ............................................................................................................................... 4407
EdgeContactType ....................................................................................................................... 4408
EdgeType ................................................................................................................................... 4408
EigenSolverType ......................................................................................................................... 4409
ElectricType ................................................................................................................................ 4409
ElectrostaticForce ....................................................................................................................... 4410
ElementControl .......................................................................................................................... 4410
ElementControlsNormalStiffnessType .......................................................................................... 4410
ElementControlsStatus ................................................................................................................ 4410
ElementMidsideNodesType ......................................................................................................... 4411
ElementMorphingType ............................................................................................................... 4411
ElementOrder ............................................................................................................................. 4411
ElementOrientationAxisType ....................................................................................................... 4412
ElementOrientationGuide ........................................................................................................... 4412
EnclosureType ............................................................................................................................ 4412
EquationSolverType .................................................................................................................... 4413
ExcitationType ............................................................................................................................ 4413
ExclusionParticipantType ............................................................................................................ 4413
ExclusionType ............................................................................................................................. 4414
EXDADRConvergenceMethod ..................................................................................................... 4414
EXDArtificialViscosityForShellsType ............................................................................................. 4414
EXDAutomaticMassScalingType .................................................................................................. 4415
EXDBeamSolutionType ............................................................................................................... 4415
EXDCharZoneDimensionType ..................................................................................................... 4415
EXDDensityUpdateType .............................................................................................................. 4416
EXDDetonationBurnType ............................................................................................................ 4416
EXDErosionOnGeomStrainType ................................................................................................... 4417
EXDErosionOnMaterialFailureType .............................................................................................. 4417
EXDErosionOnMinElemTimestepType ......................................................................................... 4417
EXDErosionRetainIntertiaType ..................................................................................................... 4418
EXDEulerBoundaryDefType ......................................................................................................... 4418
EXDEulerDomainType ................................................................................................................. 4418
EXDEulerDomScopeDefType ....................................................................................................... 4419
EXDEulerGradedDefinition .......................................................................................................... 4419
EXDEulerResolutionDefType ....................................................................................................... 4419
EXDEulerSizeDefType .................................................................................................................. 4420
EXDEulerTrackType ..................................................................................................................... 4420
EXDHexIntegrationType .............................................................................................................. 4420
EXDHourglassDampingType ....................................................................................................... 4421
EXDLinearViscosityExpansionType .............................................................................................. 4421
EXDLoadStepType ...................................................................................................................... 4421
EXDOutputContactForcesOnType ............................................................................................... 4422

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

EXDPreferenceType .................................................................................................................... 4422


EXDSavePrintSummaryOnType ................................................................................................... 4423
EXDSaveProbeDataOnType ......................................................................................................... 4423
EXDSaveRestartsOnType ............................................................................................................. 4423
EXDSaveResultsOnType .............................................................................................................. 4424
EXDSaveUserEditOnType ............................................................................................................ 4424
EXDShellInertiaUpdateType ........................................................................................................ 4424
EXDShellThicknessUpdateType ................................................................................................... 4425
EXDShellWarpCorrectionType ..................................................................................................... 4425
EXDSolverPrecisionType .............................................................................................................. 4425
EXDSolveUnitsType ..................................................................................................................... 4426
EXDSPHNodeDensityCutoffOption .............................................................................................. 4426
EXDStepawareOutputControlsType ............................................................................................. 4426
EXDTetPressureIntegrationType .................................................................................................. 4427
ExpandResultFrom ...................................................................................................................... 4427
ExpandResultsSubType ............................................................................................................... 4427
ExpansionStatus ......................................................................................................................... 4428
ExportTopologyFileOption .......................................................................................................... 4428
ExternalEnhancedModelType ...................................................................................................... 4428
ExternalLoadApplicationType ..................................................................................................... 4428
ExternalLoadDefineActiveSequenceBy ........................................................................................ 4429
ExternalLoadDisplacementType .................................................................................................. 4429
ExternalLoadDisplayComponentType .......................................................................................... 4429
ExternalLoadDisplayDataType ..................................................................................................... 4430
ExtrudeBy ................................................................................................................................... 4431
FaceMeshingMethod .................................................................................................................. 4431
FaceType .................................................................................................................................... 4431
FarFieldMicrophoneDefinitionMethodType ................................................................................. 4432
FarFieldRadiationSurfaceType ..................................................................................................... 4432
FatigueAnalysisType ................................................................................................................... 4432
FatigueFrequencySelection ......................................................................................................... 4433
FatigueLoadType ........................................................................................................................ 4433
FatigueSensitivityType ................................................................................................................ 4433
FatigueStressComponentType .................................................................................................... 4434
FatigueToolAnalysisType ............................................................................................................. 4434
FatigueToolMethod .................................................................................................................... 4434
FatigueToolResultsInputType ...................................................................................................... 4435
FeatureSuppressMethod ............................................................................................................. 4435
FEConnectionDisplay .................................................................................................................. 4435
FEConnectionDisplayType ........................................................................................................... 4436
FEConnectionLineColor .............................................................................................................. 4436
FEConnectionLineThicknessType ................................................................................................ 4436
FillingMethod ............................................................................................................................. 4437
FilterType ................................................................................................................................... 4437
FittingMethodType ..................................................................................................................... 4437
FixedOrFree ................................................................................................................................ 4438
FluentExportMeshType ............................................................................................................... 4438
FluidBehavior ............................................................................................................................. 4438
FluidDiscretizationType ............................................................................................................... 4439
ForceComponentSelectionType .................................................................................................. 4439
FormulationType ........................................................................................................................ 4439

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

FractureAffectedZone ................................................................................................................. 4440


FractureSIFSProbeSubType ......................................................................................................... 4440
FractureToolScopeType ............................................................................................................... 4440
FrequencyRangeType ................................................................................................................. 4440
FrequencyReductionType ........................................................................................................... 4441
FrequencySpacingType ............................................................................................................... 4441
FutureIntentType ........................................................................................................................ 4442
GapDefinedBy ............................................................................................................................ 4442
GapDensityType ......................................................................................................................... 4442
GAPDirectionType ...................................................................................................................... 4443
GasketResultType ....................................................................................................................... 4443
GeneralMiscellaneousOptionType ............................................................................................... 4443
GeometryDefineByType .............................................................................................................. 4444
GeometryDimensionType ........................................................................................................... 4445
GeometryType ............................................................................................................................ 4445
GPUAccelerationDevicesType ...................................................................................................... 4445
GraphControlsXAxis .................................................................................................................... 4446
Graphics3DExportFormat ............................................................................................................ 4446
GraphicsAnimationExportFormat ................................................................................................ 4446
GraphicsBackgroundType ........................................................................................................... 4447
GraphicsCaptureType ................................................................................................................. 4447
GraphicsImageExportFormat ...................................................................................................... 4447
GraphicsResolutionType ............................................................................................................. 4448
GraphicsViewportsExportBorderStyle .......................................................................................... 4448
GravityOrientationType ............................................................................................................... 4449
GrowElbowElementsBy ............................................................................................................... 4449
HarmonicMethod ....................................................................................................................... 4449
HarmonicMSUPStorage ............................................................................................................... 4450
HarmonicMultiStepType ............................................................................................................. 4450
HarmonicVariationalTechnology ***OBSOLETE*** Use 'SolutionMethod' property instead. ........... 4450
HexIntegrationType .................................................................................................................... 4450
HourglassDampingType .............................................................................................................. 4451
HyperbolicProjectionType ........................................................................................................... 4451
ICEMCFDBehavior ....................................................................................................................... 4451
ImportedCondensedPartStatus ................................................................................................... 4452
ImportedLoadType ..................................................................................................................... 4452
ImportParameterType ................................................................................................................. 4453
IncidentWaveLocation ................................................................................................................ 4453
IncrementControl ....................................................................................................................... 4454
IncrementTreatment ................................................................................................................... 4454
InitialClearanceType .................................................................................................................... 4454
InitialConditionsType .................................................................................................................. 4454
InitializationModifierType ........................................................................................................... 4455
InitialTemperatureType ............................................................................................................... 4455
InterpolateRPM ........................................................................................................................... 4455
InterpolationType ....................................................................................................................... 4456
IterationOptions ......................................................................................................................... 4456
JointConditionType .................................................................................................................... 4456
JointFormulation ........................................................................................................................ 4457
JointFrictionType ........................................................................................................................ 4457
JointGeneralPrimitiveType .......................................................................................................... 4457

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

JointInitialPosition ...................................................................................................................... 4458


JointRotationDOFType ................................................................................................................ 4458
JointScopingType ....................................................................................................................... 4458
JointSolverElementType .............................................................................................................. 4459
JointStopType ............................................................................................................................. 4459
JointType .................................................................................................................................... 4459
KinematicDOF ............................................................................................................................ 4460
KrigingCorrFuncType .................................................................................................................. 4461
KrigingPolynomType .................................................................................................................. 4461
LatticeType ................................................................................................................................. 4462
LegendColorSchemeType ........................................................................................................... 4462
LegendOrientationType .............................................................................................................. 4462
LifeUnitsType .............................................................................................................................. 4463
LimitBCDirection ........................................................................................................................ 4463
Linearized2DBehavior ................................................................................................................. 4464
LinearizedSubtype ...................................................................................................................... 4464
LineLineContactDetectionType ................................................................................................... 4464
LinePressureResultBasedOnType ................................................................................................. 4465
LineSearchType .......................................................................................................................... 4465
LoadAppliedBy ........................................................................................................................... 4465
LoadBehavior ............................................................................................................................. 4465
LoadCombinationType ................................................................................................................ 4466
LoadDefineBy ............................................................................................................................. 4466
LoadedArea ................................................................................................................................ 4467
LoadGroupingType ..................................................................................................................... 4467
LoadingApplicationType ............................................................................................................. 4467
LoadVariableVariationType .......................................................................................................... 4467
LoadVariationSubOption ............................................................................................................. 4472
LoadVariationType ...................................................................................................................... 4472
LoadVectorAssignment ............................................................................................................... 4473
LocationDefinitionMethod .......................................................................................................... 4473
LowReducedFrequencyModelType ............................................................................................. 4474
ManualContactTreatmentType .................................................................................................... 4474
ManufacturingConstraintSubtype ............................................................................................... 4474
ManuMemberSizeControlledType ............................................................................................... 4475
MappingAlgorithm ..................................................................................................................... 4475
MappingControlType .................................................................................................................. 4476
MappingInterpolationType ......................................................................................................... 4476
MappingIsolineLineType ............................................................................................................. 4476
MappingIsolineThicknessType .................................................................................................... 4477
MappingMethod ........................................................................................................................ 4477
MappingOutsideOption .............................................................................................................. 4477
MappingValidationDisplayOption ............................................................................................... 4478
MappingValidationType .............................................................................................................. 4478
MappingVariableType ................................................................................................................. 4479
MaterialPolarizationDirection ...................................................................................................... 4480
MeanStressTheoryType ............................................................................................................... 4480
MeshControlGroupRigidBodyBehaviorType ................................................................................. 4481
MeshControlGroupRigidBodyFaceMeshType ............................................................................... 4481
MeshControlPinchGeomtryType ................................................................................................. 4481
MeshDisplayStyle ........................................................................................................................ 4482

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

MeshElementShape .................................................................................................................... 4483


MeshFlowControlMethod ........................................................................................................... 4483
MeshInflationElementType ......................................................................................................... 4484
MeshMethodAlgorithm .............................................................................................................. 4484
MeshMetricType ......................................................................................................................... 4484
MeshNodeType .......................................................................................................................... 4485
MeshPhysicsPreferenceType ....................................................................................................... 4486
MeshRestartControlsType ........................................................................................................... 4486
MeshRestartRetainFilesType ........................................................................................................ 4486
MeshRestartSaveAtLoadStep ...................................................................................................... 4487
MeshRestartSaveAtSubstep ........................................................................................................ 4487
MeshSolverPreferenceType ......................................................................................................... 4487
MeshSourceType ........................................................................................................................ 4488
MessageSeverityType ................................................................................................................. 4488
MethodMeshType ....................................................................................................................... 4488
MethodType ............................................................................................................................... 4488
MinimumOrMaximum ................................................................................................................ 4489
ModalFrequencyRangeType ........................................................................................................ 4489
Model2DBehavior ....................................................................................................................... 4490
ModelColoring ............................................................................................................................ 4490
ModelDisplay .............................................................................................................................. 4491
ModelImportUnitSystemType ..................................................................................................... 4491
ModelType ................................................................................................................................. 4492
ModesCombinationType ............................................................................................................. 4492
ModeSelectionMethod ............................................................................................................... 4492
MomentsAtSummationPointType ............................................................................................... 4492
MPIType ..................................................................................................................................... 4493
MultiOptimTypeStrategyType ..................................................................................................... 4493
MultipleNodeType ...................................................................................................................... 4493
NamedSelectionWorksheetOperator ........................................................................................... 4494
NewtonRaphsonType .................................................................................................................. 4494
NLADControlProjectToGeometry ................................................................................................. 4494
NodalPlanesVisible ..................................................................................................................... 4495
NodeAndElementRenumberingMethodType ............................................................................... 4495
NodeMergeToleranceMethod ..................................................................................................... 4495
NodeMoveInformationType ........................................................................................................ 4495
NodeSelection ............................................................................................................................ 4496
NonCyclicLoadingType ............................................................................................................... 4496
NonlinearAdaptivityControlsRefinementAlgorithmType .............................................................. 4496
NonlinearAdaptivityControlsRemeshingGradientType ................................................................. 4497
NonlinearAdaptivityCriterionType ............................................................................................... 4497
NonlinearAdaptivityOptionType .................................................................................................. 4497
NonlinearAdaptivityTimeRange .................................................................................................. 4498
NonlinearAdaptivityUpdateType ................................................................................................. 4498
NonLinearFormulationType ......................................................................................................... 4498
NonLinearValueType ................................................................................................................... 4498
NormalOrientationType .............................................................................................................. 4499
ObjectiveType ............................................................................................................................ 4499
ObjectState ................................................................................................................................ 4500
OnDemandExpansionType .......................................................................................................... 4500
OptimizationResponseConstraintComponentType ...................................................................... 4501

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

OptimizationSolverType .............................................................................................................. 4501


OptimizationType ....................................................................................................................... 4501
OutputControlsNodalForcesType ................................................................................................ 4502
OutputSelection ......................................................................................................................... 4502
PartTransformationDefinitionType .............................................................................................. 4502
PassFailResult ............................................................................................................................. 4503
PatchIndependentDefineType ..................................................................................................... 4503
PathScopingType ........................................................................................................................ 4503
PeriodicApplyTo ......................................................................................................................... 4504
PeriodicityDirectionType ............................................................................................................. 4504
PeriodicRegionType .................................................................................................................... 4504
PFactorResultType ...................................................................................................................... 4505
PhaseType .................................................................................................................................. 4505
PhysicsType ................................................................................................................................ 4505
PilotNodeScopingType ............................................................................................................... 4506
PinBehavior ................................................................................................................................ 4506
PinNature ................................................................................................................................... 4507
PipeLoadingType ........................................................................................................................ 4507
PMLOptions ................................................................................................................................ 4507
PolyflowExportUnit ..................................................................................................................... 4507
PortAttribution ........................................................................................................................... 4508
PortBehavior ............................................................................................................................... 4508
PortPosition ................................................................................................................................ 4508
PressureAtZeroPenetrationType .................................................................................................. 4509
PressureInitializationType ........................................................................................................... 4509
PreStressContactStatus ............................................................................................................... 4509
PreStressLoadControl .................................................................................................................. 4510
PreStressMode ............................................................................................................................ 4510
PreStressStateType ..................................................................................................................... 4510
ProbeDisplayFilter ....................................................................................................................... 4511
ProbeExtractionType ................................................................................................................... 4512
ProbeResultType ......................................................................................................................... 4512
PrototypeDisplayStyleType ......................................................................................................... 4514
PrototypeLinkBehavior ............................................................................................................... 4514
PrototypeModelType .................................................................................................................. 4515
ProximitySFSourcesType ............................................................................................................. 4515
PSDBoundaryConditionSelectionType ......................................................................................... 4516
PullMethod ................................................................................................................................. 4516
PullOutConstraintSubtype .......................................................................................................... 4516
PullOutDirectionType .................................................................................................................. 4517
PythonCodeTargetCallback ......................................................................................................... 4517
RadiationType ............................................................................................................................. 4518
RadiositySolverType .................................................................................................................... 4518
RadiosityViewFactorType ............................................................................................................ 4518
RadiusOfReferenceSphereDefineBy ............................................................................................. 4518
RandomSamplingType ................................................................................................................ 4519
RBDCorrectionType ..................................................................................................................... 4519
RBDDoStaticAnalysisType ........................................................................................................... 4519
RBDProgramControlType ............................................................................................................ 4520
RBDTimeIntegrationType ............................................................................................................ 4520
ReactionForceCriteriaType .......................................................................................................... 4521

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

ReferenceFrameType .................................................................................................................. 4521


ReflectionCoefficientsType .......................................................................................................... 4522
ReinforcingStressState ................................................................................................................ 4522
RemeshHexDominantToTetrahedral ............................................................................................ 4522
RemoteApplicationType .............................................................................................................. 4523
RemotePointDOFSelectionType .................................................................................................. 4523
RemotePointFormulation ............................................................................................................ 4523
RemotePointUpdateOptions ....................................................................................................... 4523
ResponseConstraintDefineBy ...................................................................................................... 4524
ResponseConstraintType ............................................................................................................. 4524
RestartControlsType .................................................................................................................... 4525
RestartRetainFilesType ................................................................................................................ 4525
RestartSaveAtLoadStep ............................................................................................................... 4525
RestartSaveAtSubstep ................................................................................................................. 4526
RestartType ................................................................................................................................ 4526
ResultAnimationRangeType ........................................................................................................ 4526
ResultAveragingType .................................................................................................................. 4526
ResultFileCompressionType ........................................................................................................ 4527
ResultFileItemType ..................................................................................................................... 4527
ResultRelativityType .................................................................................................................... 4528
ResultType .................................................................................................................................. 4528
RigidBodyTransformationType .................................................................................................... 4536
RigidResponseEffectType ............................................................................................................ 4536
RobustFrequenciesReductionType .............................................................................................. 4537
RotationPlane ............................................................................................................................. 4537
RSBoundaryConditionSelectionType ........................................................................................... 4537
SafetyLimitType .......................................................................................................................... 4538
SafetyTheoryType ....................................................................................................................... 4538
ScaleFactorType .......................................................................................................................... 4538
ScatteredFieldFormulation .......................................................................................................... 4539
ScatteringOutputType ................................................................................................................ 4539
SecondaryImportPrefType .......................................................................................................... 4539
SectionPlaneCappingType .......................................................................................................... 4540
SectionPlaneType ....................................................................................................................... 4540
SelectionActionType ................................................................................................................... 4541
SelectionCriterionType ................................................................................................................ 4541
SelectionOperatorType ............................................................................................................... 4544
SelectionType ............................................................................................................................. 4545
SendAs ....................................................................................................................................... 4546
SeqSelectionMode ...................................................................................................................... 4546
SequenceSelectionType .............................................................................................................. 4547
SetDriverStyle ............................................................................................................................. 4547
ShearMomentDiagramOrientationType ....................................................................................... 4548
ShearMomentType ..................................................................................................................... 4548
ShearOrientationType ................................................................................................................. 4548
ShellBodyDimension ................................................................................................................... 4548
ShellElementStiffnessOption ....................................................................................................... 4549
ShellFaceType ............................................................................................................................. 4549
ShellInertiaUpdate ...................................................................................................................... 4549
ShellMBPOrientationType ........................................................................................................... 4550
ShellMBPType ............................................................................................................................. 4550

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

ShellOffsetType ........................................................................................................................... 4550


ShellThicknessUpdate ................................................................................................................. 4551
SizingBehavior ............................................................................................................................ 4551
SizingType .................................................................................................................................. 4551
SlidingContactType ..................................................................................................................... 4552
SnapType ................................................................................................................................... 4552
SolutionCombinationDriverStyle ................................................................................................. 4552
SolutionOutputType ................................................................................................................... 4553
SolutionStatusType ..................................................................................................................... 4554
SolveBehaviourType ................................................................................................................... 4555
SolverControlsIncludeNegativeLoadMultiplier ............................................................................. 4555
SolverControlsModeReuse .......................................................................................................... 4555
SolverPivotChecking ................................................................................................................... 4555
SolverType .................................................................................................................................. 4556
SolverUnitsControlType .............................................................................................................. 4556
SortingType ................................................................................................................................ 4557
SourceConductorType ................................................................................................................ 4557
SourceDimension ....................................................................................................................... 4557
SourceTimeDefinitionType .......................................................................................................... 4557
SpacingOptionType .................................................................................................................... 4558
SpatialRadiationType .................................................................................................................. 4558
SpatialReductionMethodType ..................................................................................................... 4558
SpatialReductionType ................................................................................................................. 4559
SpectrumType ............................................................................................................................ 4559
SpinSofteningType ..................................................................................................................... 4559
SpotWeldTypes ........................................................................................................................... 4560
SpringBehavior ........................................................................................................................... 4560
SpringPreloadType ..................................................................................................................... 4560
SpringResultType ........................................................................................................................ 4561
SpringScopingType ..................................................................................................................... 4561
SpringsStiffnessType ................................................................................................................... 4561
SpringType ................................................................................................................................. 4561
StabilizationFirstSubstepOption .................................................................................................. 4562
StabilizationMethod ................................................................................................................... 4562
StabilizationType ........................................................................................................................ 4562
StackerMethodMeshType ........................................................................................................... 4563
StageBehavior ............................................................................................................................ 4563
StepVarying ................................................................................................................................ 4563
StiffnessBehavior ........................................................................................................................ 4563
StiffnessMethodType .................................................................................................................. 4564
STLSupportViewType .................................................................................................................. 4564
StopCriterion .............................................................................................................................. 4565
StoreModalResult ....................................................................................................................... 4565
StressStrainType ......................................................................................................................... 4565
SubScopingDefineByType ........................................................................................................... 4566
SurfaceCoatingStiffnessBehavior ................................................................................................. 4566
SweepAxisymmetricFallBackMeshType ........................................................................................ 4566
SweepElementOptionType .......................................................................................................... 4567
SymmetryBehavior ..................................................................................................................... 4567
SymmetryBoundaryDOFOrientation ............................................................................................ 4567
SymmetryNormalType ................................................................................................................ 4567

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

SymmetryRegionType ................................................................................................................. 4568


TargetCorrection ......................................................................................................................... 4568
TargetOrientation ....................................................................................................................... 4568
TetIntegrationType ..................................................................................................................... 4569
ThermalPointMassBehavior ......................................................................................................... 4569
ThermalStrainType ...................................................................................................................... 4569
ThermoelasticDampingType ....................................................................................................... 4570
ThroughThicknessBendingStress ................................................................................................. 4570
TimeHistoryDisplayType ............................................................................................................. 4570
TimePointsOptions ..................................................................................................................... 4571
TimeStepDefineByType ............................................................................................................... 4571
ToleranceType ............................................................................................................................ 4571
TopoBoundType ......................................................................................................................... 4572
TopoConstraintStressType ........................................................................................................... 4572
TopoConstraintType .................................................................................................................... 4572
TopoEnvironmentType ................................................................................................................ 4573
TopoLocalDesignRestrictionNature ............................................................................................. 4573
TopologyOptimizationResultShowType ....................................................................................... 4573
TopoObjectiveFormulation ......................................................................................................... 4574
TopoOptimizationDensityFilter ................................................................................................... 4574
TopoOptimizationExportDesignProperties .................................................................................. 4575
TopoOptimizationExportDesignPropertiesFileFormat .................................................................. 4575
TopoOptimizationOutputLog ...................................................................................................... 4575
TopoPropertyControlType ........................................................................................................... 4575
TotalOrDirectional ...................................................................................................................... 4576
TransferAdmittanceModelType ................................................................................................... 4576
TransformationType .................................................................................................................... 4576
TransientApplicationType ........................................................................................................... 4577
TransientDampingType ............................................................................................................... 4577
TransitionType ............................................................................................................................ 4577
TreeFilterObjectClass .................................................................................................................. 4578
TreeFilterObjectState .................................................................................................................. 4578
TreeFilterScopingType ................................................................................................................ 4578
TriangleReduction ...................................................................................................................... 4579
UnitCategoryType ....................................................................................................................... 4579
UnitSystemIDType ...................................................................................................................... 4582
UpdateContactStiffness .............................................................................................................. 4583
UpdateViewFactor ...................................................................................................................... 4583
UseExistingModesymFile ............................................................................................................ 4584
UserUnitSystemType ................................................................................................................... 4584
VectorDisplayType ...................................................................................................................... 4585
VectorLengthType ...................................................................................................................... 4585
VectorReductionReferenceType .................................................................................................. 4585
VectorReductionType .................................................................................................................. 4586
ViewOrientationType .................................................................................................................. 4586
VirtualCellClassType .................................................................................................................... 4587
VirtualCellGroupAutomaticBehaviorType .................................................................................... 4587
VirtualCellGroupMethodType ...................................................................................................... 4587
VirtualCellGroupRepairBehaviorType ........................................................................................... 4588
VisibilityType .............................................................................................................................. 4588
WaveType ................................................................................................................................... 4588

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

WBUnitSystemType .................................................................................................................... 4589


WeakSpringsType ....................................................................................................................... 4590
WeightingType ........................................................................................................................... 4590
WindowType .............................................................................................................................. 4591
XAxisValues ................................................................................................................................ 4591
YesNoProgrammedControlled ..................................................................................................... 4592
YesNoType .................................................................................................................................. 4592
Ansys.Mechanical.DataModel.Enums.GeometryImportPreference Namespace ........................... 4593
AnalysisType ............................................................................................................................... 4593
ComparePartsOnUpdate ............................................................................................................. 4594
ComparePartsTolerance .............................................................................................................. 4594
FacetQuality ............................................................................................................................... 4594
Format ....................................................................................................................................... 4595
MixedImportResolution .............................................................................................................. 4595
Parameters ................................................................................................................................. 4595
StitchSurfacesOnImport .............................................................................................................. 4596
Ansys.Mechanical.DataModel.Enums.ExternalModel Namespace ................................................ 4597
ImportedSurfaceLoadType .......................................................................................................... 4597
Ansys.Mechanical.DataModel.Constants Namespace .................................................................... 4599
Colors ......................................................................................................................................... 4599
Blue ...................................................................................................................................... 4599
Cyan ..................................................................................................................................... 4600
Gray ..................................................................................................................................... 4600
Green ................................................................................................................................... 4600
Red ....................................................................................................................................... 4600
White ................................................................................................................................... 4600
Yellow .................................................................................................................................. 4600
Ansys.Mechanical.Interfaces Namespace ....................................................................................... 4603
IDataSeries ................................................................................................................................. 4603
DataType .............................................................................................................................. 4603
Name ................................................................................................................................... 4604
QuantityName ...................................................................................................................... 4604
Unit ...................................................................................................................................... 4604
Values ................................................................................................................................... 4604
IDataTable .................................................................................................................................. 4604
ColumnNames ...................................................................................................................... 4605
Columns ............................................................................................................................... 4605
Count ................................................................................................................................... 4606
IsFixedColumnCount ............................................................................................................. 4606
IsFixedRowCount .................................................................................................................. 4606
IsReadOnly ........................................................................................................................... 4606
Item(object) .......................................................................................................................... 4606
Metadata .............................................................................................................................. 4607
Name ................................................................................................................................... 4607
RowCount ............................................................................................................................ 4607
Add(IDataSeries) ................................................................................................................... 4607
Clear() ................................................................................................................................... 4607
Contains(string) .................................................................................................................... 4608
GetRow(int) .......................................................................................................................... 4608
Insert(int, IDataSeries) ........................................................................................................... 4608
Remove(object) .................................................................................................................... 4608

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

TryInsertRow(int, IEnumerable) .............................................................................................. 4609


TryRemoveRow(int) .............................................................................................................. 4609
IReadOnlyDataSeries ................................................................................................................... 4609
Count ................................................................................................................................... 4610
DataType .............................................................................................................................. 4610
Item(int) ............................................................................................................................... 4610
Name ................................................................................................................................... 4610
QuantityName ...................................................................................................................... 4611
Unit ...................................................................................................................................... 4611
Values ................................................................................................................................... 4611
IReadOnlyDataTable ................................................................................................................... 4611
ColumnNames ...................................................................................................................... 4612
Columns ............................................................................................................................... 4612
Item(object) .......................................................................................................................... 4612
Metadata .............................................................................................................................. 4612
Name ................................................................................................................................... 4612
RowCount ............................................................................................................................ 4612
GetRow(int) .......................................................................................................................... 4613
ITable ......................................................................................................................................... 4613
Dependents .......................................................................................................................... 4613
Independents ....................................................................................................................... 4613
IVariable ..................................................................................................................................... 4614
QuantityName ...................................................................................................................... 4614
Unit ...................................................................................................................................... 4614
Ansys.ACT.WorkBench.Schematic Namespace ............................................................................... 4615
UserTask ..................................................................................................................................... 4615
ActiveDirectory ..................................................................................................................... 4616
Component .......................................................................................................................... 4616
EditIcon ................................................................................................................................ 4616
InputData ............................................................................................................................. 4617
InternalObject ...................................................................................................................... 4617
OutputData .......................................................................................................................... 4617
Parameters ........................................................................................................................... 4617
Properties ............................................................................................................................. 4617
RegisteredFiles ..................................................................................................................... 4618
SourceTasks .......................................................................................................................... 4618
TargetTasks ........................................................................................................................... 4618
TaskGroup ............................................................................................................................ 4618
TaskState .............................................................................................................................. 4618
Template .............................................................................................................................. 4618
TransferData ......................................................................................................................... 4619
Type ..................................................................................................................................... 4619
Edit( params object[]) ............................................................................................................ 4619
ExecuteCommand(string, IDictionary<string, object>) ........................................................... 4619
Exit( params object[]) ............................................................................................................ 4620
RegisterFile(string) ................................................................................................................ 4620
Send( params object[]) .......................................................................................................... 4620
SignalModified() ................................................................................................................... 4620
SignalOutputsGenerated() .................................................................................................... 4621
UnregisterFile(DataReference) ............................................................................................... 4621
UnregisterFile(string) ............................................................................................................ 4621

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

UnregisterFile(DataReference, bool) ....................................................................................... 4621


UnregisterFile(string, bool) .................................................................................................... 4622
UserTaskGroup ........................................................................................................................... 4622
Abbreviation ......................................................................................................................... 4623
Caption ................................................................................................................................ 4623
Category .............................................................................................................................. 4623
HeaderText ........................................................................................................................... 4623
InternalObject ...................................................................................................................... 4623
IsParametricGroup ................................................................................................................ 4623
Name ................................................................................................................................... 4624
Tasks .................................................................................................................................... 4624
Template .............................................................................................................................. 4624
UserTaskGroupTemplate ............................................................................................................. 4624
Abbreviation ......................................................................................................................... 4625
Caption ................................................................................................................................ 4625
Category .............................................................................................................................. 4625
HeaderText ........................................................................................................................... 4625
InternalObject ...................................................................................................................... 4625
IsParametricGroup ................................................................................................................ 4625
Name ................................................................................................................................... 4626
UserTaskTemplate ....................................................................................................................... 4626
InternalObject ...................................................................................................................... 4626
Ansys.ACT.WorkBench.Queries Namespace ................................................................................... 4627
GetExtensionApiQuery ............................................................................................................... 4627
InvokeAndWait(string, string) ................................................................................................ 4628
InvokeAndWait(InvokeConfiguration, string, string) ................................................................ 4628
InvokeAndWait(IQueryContext, string, string) ......................................................................... 4629
InvokeAndWait(IQueryContext, InvokeConfiguration, string, string) ........................................ 4629
InvokeAndWait(IQueryContext, IProgressMonitor, string, string) ............................................. 4630
InvokeAsync(string, string) .................................................................................................... 4631
InvokeAsync(InvokeConfiguration, string, string) .................................................................... 4631
InvokeAsync(IQueryContext, string, string) ............................................................................. 4631
InvokeAsync(IQueryContext, InvokeConfiguration, string, string) ............................................ 4632
InvokeAsync(IQueryContext, IProgressMonitor, string, string) ................................................. 4633
Ansys.ACT.WorkBench.Commands Namespace ............................................................................. 4635
ExecuteNextStepCommand ........................................................................................................ 4635
InvokeAndWait(string) .......................................................................................................... 4637
InvokeAndWait(InvokeConfiguration, string) .......................................................................... 4637
InvokeAndWait(IProtectedContext, string) ............................................................................. 4638
InvokeAndWait(IProtectedContext, InvokeConfiguration, string) ............................................ 4638
InvokeAndWait(IProtectedContext, IProgressMonitor, string) .................................................. 4639
InvokeAsync(string) .............................................................................................................. 4639
InvokeAsync(InvokeConfiguration, string) .............................................................................. 4640
InvokeAsync(IProtectedContext, string) ................................................................................. 4640
InvokeAsync(IProtectedContext, InvokeConfiguration, string) ................................................. 4641
InvokeAsync(IProtectedContext, IProgressMonitor, string) ...................................................... 4641
ExecutePreviousStepCommand .................................................................................................. 4642
InvokeAndWait() ................................................................................................................... 4644
InvokeAndWait(InvokeConfiguration) .................................................................................... 4644
InvokeAndWait(IProtectedContext) ....................................................................................... 4644
InvokeAndWait(IProtectedContext, InvokeConfiguration) ....................................................... 4645

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

InvokeAndWait(IProtectedContext, IProgressMonitor) ............................................................ 4645


InvokeAsync() ....................................................................................................................... 4646
InvokeAsync(InvokeConfiguration) ........................................................................................ 4646
InvokeAsync(IProtectedContext) ........................................................................................... 4646
InvokeAsync(IProtectedContext, InvokeConfiguration) ........................................................... 4646
InvokeAsync(IProtectedContext, IProgressMonitor) ................................................................ 4647
ExecuteWorkbenchScriptCommand ............................................................................................ 4647
InvokeAndWait() ................................................................................................................... 4649
InvokeAndWait(InvokeConfiguration) .................................................................................... 4650
InvokeAndWait(IProtectedContext) ....................................................................................... 4650
InvokeAndWait(IProtectedContext, InvokeConfiguration) ....................................................... 4650
InvokeAndWait(IProtectedContext, IProgressMonitor) ............................................................ 4651
InvokeAsync() ....................................................................................................................... 4651
InvokeAsync(InvokeConfiguration) ........................................................................................ 4651
InvokeAsync(IProtectedContext) ........................................................................................... 4652
InvokeAsync(IProtectedContext, InvokeConfiguration) ........................................................... 4652
InvokeAsync(IProtectedContext, IProgressMonitor) ................................................................ 4653
StartWizardCommand ................................................................................................................. 4653
Ansys.ACT.WorkBench.Automation.Workflows Namespace .......................................................... 4655
Parameter ................................................................................................................................... 4655
Caption ................................................................................................................................ 4655
InternalObject ...................................................................................................................... 4656
Name ................................................................................................................................... 4656
Usage ................................................................................................................................... 4656
Value .................................................................................................................................... 4656
Property ..................................................................................................................................... 4656
Name ................................................................................................................................... 4657
Value .................................................................................................................................... 4657
Task ............................................................................................................................................ 4657
ActiveDirectory ..................................................................................................................... 4659
AlwaysIncludeInDPUpdate .................................................................................................... 4659
Caption ................................................................................................................................ 4659
Container ............................................................................................................................. 4659
CoordinateId ........................................................................................................................ 4659
CoupledClients ..................................................................................................................... 4660
CoupledToTask ..................................................................................................................... 4660
DirectoryName ..................................................................................................................... 4660
ImageName .......................................................................................................................... 4660
InputData ............................................................................................................................. 4660
InternalObject ...................................................................................................................... 4660
IsFailedState ......................................................................................................................... 4661
IsSharing .............................................................................................................................. 4661
MasterTask ........................................................................................................................... 4661
Name ................................................................................................................................... 4661
Notes .................................................................................................................................... 4661
OutputData .......................................................................................................................... 4661
Parameters ........................................................................................................................... 4662
Properties ............................................................................................................................. 4662
RealTask ............................................................................................................................... 4662
Solver ................................................................................................................................... 4662
SourceTasks .......................................................................................................................... 4662

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

State ..................................................................................................................................... 4662


TargetTasks ........................................................................................................................... 4663
TaskGroup ............................................................................................................................ 4663
TaskId ................................................................................................................................... 4663
Template .............................................................................................................................. 4663
UsedLicenses ........................................................................................................................ 4663
UserId ................................................................................................................................... 4663
UserTask ............................................................................................................................... 4664
Clean() .................................................................................................................................. 4664
ExecuteCommand(string, IDictionary<string, object>) ........................................................... 4664
GetPropertyNames() ............................................................................................................. 4664
Refresh() ............................................................................................................................... 4665
Remove() .............................................................................................................................. 4665
Reset() .................................................................................................................................. 4665
Update() ............................................................................................................................... 4665
TaskGroup .................................................................................................................................. 4665
Abbreviation ......................................................................................................................... 4666
AnalysisType ......................................................................................................................... 4666
Caption ................................................................................................................................ 4667
DirectoryName ..................................................................................................................... 4667
HeaderText ........................................................................................................................... 4667
InternalObject ...................................................................................................................... 4667
IsParametric .......................................................................................................................... 4667
Name ................................................................................................................................... 4667
Notes .................................................................................................................................... 4668
Physics ................................................................................................................................. 4668
Solver ................................................................................................................................... 4668
TaskGroupId ......................................................................................................................... 4668
Tasks .................................................................................................................................... 4668
Template .............................................................................................................................. 4668
Clean() .................................................................................................................................. 4669
Copy() .................................................................................................................................. 4669
Delete() ................................................................................................................................ 4669
GetTaskById(string) ............................................................................................................... 4669
RecreateDeletedTasks() ......................................................................................................... 4669
Refresh() ............................................................................................................................... 4670
Update() ............................................................................................................................... 4670
TaskGroupTemplate .................................................................................................................... 4670
AnalysisType ......................................................................................................................... 4671
Attributes ............................................................................................................................. 4671
Category .............................................................................................................................. 4672
DisplayName ........................................................................................................................ 4672
ExcludedTaskTemplates ........................................................................................................ 4672
HeaderText ........................................................................................................................... 4672
ImageName .......................................................................................................................... 4672
InternalObject ...................................................................................................................... 4672
IsBeta ................................................................................................................................... 4673
IsDeletable ........................................................................................................................... 4673
IsParametric .......................................................................................................................... 4673
Name ................................................................................................................................... 4673
Physics ................................................................................................................................. 4673

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

PostCreationSteps ................................................................................................................. 4673


RequiredTaskTemplates ........................................................................................................ 4674
Solver ................................................................................................................................... 4674
TaskGroupHelpId .................................................................................................................. 4674
TaskGroupType ..................................................................................................................... 4674
TaskGroupTypeAbbreviation ................................................................................................. 4674
TaskNames ........................................................................................................................... 4674
TaskTemplates ...................................................................................................................... 4675
ToolboxGroup ....................................................................................................................... 4675
ToolTipHelpId ....................................................................................................................... 4675
ToolTipText ........................................................................................................................... 4675
Visible .................................................................................................................................. 4675
TaskTemplate .............................................................................................................................. 4676
AboutToResetCommandName .............................................................................................. 4680
AvailableTransferTasks .......................................................................................................... 4680
CanDuplicateQueryName ..................................................................................................... 4680
CanUseTransferDataQueryName ........................................................................................... 4680
CleanCommandName ........................................................................................................... 4680
ComponentImageName ....................................................................................................... 4681
ComponentPropertyDataQueryName ................................................................................... 4681
CreateAllProvidesConnectionsToNewSystem ......................................................................... 4681
CreatingCommandName ...................................................................................................... 4681
DataGroupStatusQueryName ................................................................................................ 4681
DataGroupUpdateCommandName ....................................................................................... 4681
DataSourceListChangedCommandName .............................................................................. 4682
DefaultTransferName ............................................................................................................ 4682
DeletingCommandName ...................................................................................................... 4682
DesignPointReportContentCreationCommandName ............................................................. 4682
DisplayName ........................................................................................................................ 4682
DontShareByDefault ............................................................................................................. 4682
DuplicateGroup .................................................................................................................... 4683
DuplicateTaskCommandName .............................................................................................. 4683
EditorInitiatedRemoteUpdateInfoQueryName ....................................................................... 4683
EquivalentInputs ................................................................................................................... 4683
GetEnvironmentForRsmDpUpdateQueryName ...................................................................... 4683
GetRemoteUpdateMonitorFilesQueryName .......................................................................... 4684
IncludeInPartialUpdate ......................................................................................................... 4684
InternalObject ...................................................................................................................... 4684
IsAim .................................................................................................................................... 4684
IsDeletable ........................................................................................................................... 4684
IsDisabled ............................................................................................................................. 4684
IsReplaceable ........................................................................................................................ 4685
IsReplaceableWithSharing ..................................................................................................... 4685
IsResults ............................................................................................................................... 4685
IsShareable ........................................................................................................................... 4685
Name ................................................................................................................................... 4685
OutputTypes ......................................................................................................................... 4686
RefreshAfterPartialUpdate ..................................................................................................... 4686
RefreshCommandName ........................................................................................................ 4686
RemoteSolvePermissionsQueryName .................................................................................... 4686
ReportContentCreationCommandName ............................................................................... 4686

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

RequiredInputTypes .............................................................................................................. 4686


ResetCommandName ........................................................................................................... 4687
ShowOptionToAlwaysBePartOfDpUpdate ............................................................................. 4687
Solver ................................................................................................................................... 4687
SubTasks ............................................................................................................................... 4687
SubTaskStatusQueryName .................................................................................................... 4687
TaskStatusQueryName .......................................................................................................... 4687
TaskTypeAbbreviation ........................................................................................................... 4688
UpdateCommandName ........................................................................................................ 4688
ValidationCodes .................................................................................................................... 4688
WillBePendingUponUpdateQueryName ................................................................................ 4688
WillBeUpdatedViaRsmQueryName ........................................................................................ 4688

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cclvii
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cclviii of ANSYS, Inc. and its subsidiaries and affiliates.
List of Tables
1. Members .................................................................................................................................................. 3
2. Members .................................................................................................................................................. 3
3. Members .................................................................................................................................................. 4
4. Members .................................................................................................................................................. 5
5. Members .................................................................................................................................................. 5
6. Members .................................................................................................................................................. 7
7. Members .................................................................................................................................................. 7
8. Members ................................................................................................................................................. 10
9. Members ................................................................................................................................................. 11
10. Members ............................................................................................................................................... 11
11. Members ............................................................................................................................................... 12
12. Members ............................................................................................................................................... 14
13. Members ............................................................................................................................................... 17
14. Members ............................................................................................................................................... 17
15. Members ............................................................................................................................................... 19
16. Members ............................................................................................................................................... 19
17. Members ............................................................................................................................................... 21
18. Members ............................................................................................................................................... 21
19. Members ............................................................................................................................................... 22
20. Members ............................................................................................................................................... 23
21. Members ............................................................................................................................................... 23
22. Members ............................................................................................................................................... 25
23. Members ............................................................................................................................................... 26
24. Members ............................................................................................................................................... 27
25. Members ............................................................................................................................................... 28
26. Members ............................................................................................................................................... 29
27. Members ............................................................................................................................................... 29
28. Members ............................................................................................................................................... 31
29. Members ............................................................................................................................................... 32
30. Members ............................................................................................................................................... 34
31. Members ............................................................................................................................................... 37
32. Members ............................................................................................................................................... 39
33. Members ............................................................................................................................................... 39
34. Members ............................................................................................................................................... 41
35. Members ............................................................................................................................................... 42
36. Members ............................................................................................................................................... 42
37. Members ............................................................................................................................................... 44
38. Members ............................................................................................................................................... 47
39. Members ............................................................................................................................................... 48
40. Members ............................................................................................................................................... 49
41. Members ............................................................................................................................................... 52
42. Members ............................................................................................................................................... 56
43. Members ............................................................................................................................................... 58
44. Members ............................................................................................................................................... 59
45. Members ............................................................................................................................................... 59
46. Members ............................................................................................................................................... 60
47. Members ............................................................................................................................................... 61
48. Members ............................................................................................................................................... 61
49. Members ............................................................................................................................................... 62

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

50. Members ............................................................................................................................................... 63


51. Members ............................................................................................................................................... 67
52. Members ............................................................................................................................................... 68
53. Members ............................................................................................................................................... 69
54. Members ............................................................................................................................................... 71
55. Members ............................................................................................................................................... 73
56. Members ............................................................................................................................................... 76
57. Members ............................................................................................................................................... 78
58. Members ............................................................................................................................................... 80
59. Members ............................................................................................................................................... 82
60. Members ............................................................................................................................................... 84
61. Members ............................................................................................................................................... 86
62. Members ............................................................................................................................................... 93
63. Members ............................................................................................................................................... 93
64. Members ............................................................................................................................................... 99
65. Members ............................................................................................................................................. 107
66. Members ............................................................................................................................................. 107
67. Members ............................................................................................................................................. 111
68. Members ............................................................................................................................................. 113
69. Members ............................................................................................................................................. 114
70. Members ............................................................................................................................................. 117
71. Members ............................................................................................................................................. 117
72. Members ............................................................................................................................................. 118
73. Members ............................................................................................................................................. 119
74. Members ............................................................................................................................................. 119
75. Members ............................................................................................................................................. 121
76. Members ............................................................................................................................................. 121
77. Members ............................................................................................................................................. 123
78. Members ............................................................................................................................................. 123
79. Members ............................................................................................................................................. 124
80. Members ............................................................................................................................................. 125
81. Members ............................................................................................................................................. 129
82. Members ............................................................................................................................................. 131
83. Members ............................................................................................................................................. 131
84. Members ............................................................................................................................................. 132
85. Members ............................................................................................................................................. 133
86. Members ............................................................................................................................................. 135
87. Members ............................................................................................................................................. 137
88. Members ............................................................................................................................................. 137
89. Members ............................................................................................................................................. 145
90. Members ............................................................................................................................................. 145
91. Members ............................................................................................................................................. 146
92. Members ............................................................................................................................................. 148
93. Members ............................................................................................................................................. 149
94. Members ............................................................................................................................................. 153
95. Members ............................................................................................................................................. 153
96. Members ............................................................................................................................................. 154
97. Members ............................................................................................................................................. 156
98. Members ............................................................................................................................................. 157
99. Members ............................................................................................................................................. 158
100. Members ........................................................................................................................................... 162

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

101. Members ........................................................................................................................................... 165


102. Members ........................................................................................................................................... 165
103. Members ........................................................................................................................................... 166
104. Members ........................................................................................................................................... 166
105. Members ........................................................................................................................................... 167
106. Members ........................................................................................................................................... 169
107. Members ........................................................................................................................................... 170
108. Members ........................................................................................................................................... 172
109. Members ........................................................................................................................................... 172
110. Members ........................................................................................................................................... 174
111. Members ........................................................................................................................................... 174
112. Members ........................................................................................................................................... 175
113. Members ........................................................................................................................................... 176
114. Members ........................................................................................................................................... 177
115. Members ........................................................................................................................................... 179
116. Members ........................................................................................................................................... 184
117. Members ........................................................................................................................................... 186
118. Members ........................................................................................................................................... 187
119. Members ........................................................................................................................................... 189
120. Members ........................................................................................................................................... 190
121. Members ........................................................................................................................................... 191
122. Members ........................................................................................................................................... 191
123. Members ........................................................................................................................................... 192
124. Members ........................................................................................................................................... 193
125. Members ........................................................................................................................................... 194
126. Members ........................................................................................................................................... 195
127. Members ........................................................................................................................................... 196
128. Members ........................................................................................................................................... 198
129. Members ........................................................................................................................................... 198
130. Members ........................................................................................................................................... 199
131. Members ........................................................................................................................................... 199
132. Members ........................................................................................................................................... 201
133. Members ........................................................................................................................................... 202
134. Members ........................................................................................................................................... 203
135. Members ........................................................................................................................................... 203
136. Members ........................................................................................................................................... 207
137. Members ........................................................................................................................................... 207
138. Members ........................................................................................................................................... 213
139. Members ........................................................................................................................................... 213
140. Members ........................................................................................................................................... 215
141. Members ........................................................................................................................................... 216
142. Members ........................................................................................................................................... 216
143. Members ........................................................................................................................................... 217
144. Members ........................................................................................................................................... 218
145. Members ........................................................................................................................................... 219
146. Members ........................................................................................................................................... 219
147. Members ........................................................................................................................................... 221
148. Members ........................................................................................................................................... 225
149. Members ........................................................................................................................................... 226
150. Members ........................................................................................................................................... 229
151. Members ........................................................................................................................................... 233

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

152. Members ........................................................................................................................................... 239


153. Members ........................................................................................................................................... 239
154. Members ........................................................................................................................................... 241
155. Members ........................................................................................................................................... 241
156. Members ........................................................................................................................................... 242
157. Members ........................................................................................................................................... 245
158. Members ........................................................................................................................................... 251
159. Members ........................................................................................................................................... 255
160. Members ........................................................................................................................................... 257
161. Members ........................................................................................................................................... 295
162. Members ........................................................................................................................................... 299
163. Members ........................................................................................................................................... 304
164. Members ........................................................................................................................................... 305
165. Members ........................................................................................................................................... 311
166. Members ........................................................................................................................................... 331
167. Members ........................................................................................................................................... 333
168. Members ........................................................................................................................................... 335
169. Members ........................................................................................................................................... 340
170. Members ........................................................................................................................................... 341
171. Members ........................................................................................................................................... 343
172. Members ........................................................................................................................................... 344
173. Members ........................................................................................................................................... 353
174. Members ........................................................................................................................................... 355
175. Members ........................................................................................................................................... 356
176. Members ........................................................................................................................................... 357
177. Members ........................................................................................................................................... 359
178. Members ........................................................................................................................................... 361
179. Members ........................................................................................................................................... 363
180. Members ........................................................................................................................................... 368
181. Members ........................................................................................................................................... 373
182. Members ........................................................................................................................................... 379
183. Members ........................................................................................................................................... 380
184. Members ........................................................................................................................................... 383
185. Members ........................................................................................................................................... 385
186. Members ........................................................................................................................................... 386
187. Members ........................................................................................................................................... 391
188. Members ........................................................................................................................................... 395
189. Members ........................................................................................................................................... 398
190. Members ........................................................................................................................................... 400
191. Members ........................................................................................................................................... 403
192. Members ........................................................................................................................................... 406
193. Members ........................................................................................................................................... 423
194. Members ........................................................................................................................................... 427
195. Members ........................................................................................................................................... 433
196. Members ........................................................................................................................................... 436
197. Members ........................................................................................................................................... 442
198. Members ........................................................................................................................................... 446
199. Members ........................................................................................................................................... 450
200. Members ........................................................................................................................................... 452
201. Members ........................................................................................................................................... 455
202. Members ........................................................................................................................................... 461

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

203. Members ........................................................................................................................................... 463


204. Members ........................................................................................................................................... 464
205. Members ........................................................................................................................................... 470
206. Members ........................................................................................................................................... 473
207. Members ........................................................................................................................................... 475
208. Members ........................................................................................................................................... 477
209. Members ........................................................................................................................................... 479
210. Members ........................................................................................................................................... 485
211. Members ........................................................................................................................................... 490
212. Members ........................................................................................................................................... 497
213. Members ........................................................................................................................................... 502
214. Members ........................................................................................................................................... 509
215. Members ........................................................................................................................................... 513
216. Members ........................................................................................................................................... 517
217. Members ........................................................................................................................................... 519
218. Members ........................................................................................................................................... 522
219. Members ........................................................................................................................................... 532
220. Members ........................................................................................................................................... 536
221. Members ........................................................................................................................................... 546
222. Members ........................................................................................................................................... 549
223. Members ........................................................................................................................................... 556
224. Members ........................................................................................................................................... 560
225. Members ........................................................................................................................................... 564
226. Members ........................................................................................................................................... 568
227. Members ........................................................................................................................................... 572
228. Members ........................................................................................................................................... 591
229. Members ........................................................................................................................................... 595
230. Members ........................................................................................................................................... 600
231. Members ........................................................................................................................................... 604
232. Members ........................................................................................................................................... 606
233. Members ........................................................................................................................................... 609
234. Members ........................................................................................................................................... 612
235. Members ........................................................................................................................................... 613
236. Members ........................................................................................................................................... 616
237. Members ........................................................................................................................................... 619
238. Members ........................................................................................................................................... 624
239. Members ........................................................................................................................................... 626
240. Members ........................................................................................................................................... 634
241. Members ........................................................................................................................................... 635
242. Members ........................................................................................................................................... 636
243. Members ........................................................................................................................................... 638
244. Members ........................................................................................................................................... 639
245. Members ........................................................................................................................................... 640
246. Members ........................................................................................................................................... 641
247. Members ........................................................................................................................................... 643
248. Members ........................................................................................................................................... 644
249. Members ........................................................................................................................................... 646
250. Members ........................................................................................................................................... 649
251. Members ........................................................................................................................................... 650
252. Members ........................................................................................................................................... 651
253. Members ........................................................................................................................................... 652

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

254. Members ........................................................................................................................................... 653


255. Members ........................................................................................................................................... 654
256. Members ........................................................................................................................................... 656
257. Members ........................................................................................................................................... 668
258. Members ........................................................................................................................................... 672
259. Members ........................................................................................................................................... 676
260. Members ........................................................................................................................................... 685
261. Members ........................................................................................................................................... 691
262. Members ........................................................................................................................................... 696
263. Members ........................................................................................................................................... 698
264. Members ........................................................................................................................................... 700
265. Members ........................................................................................................................................... 701
266. Members ........................................................................................................................................... 703
267. Members ........................................................................................................................................... 705
268. Members ........................................................................................................................................... 712
269. Members ........................................................................................................................................... 714
270. Members ........................................................................................................................................... 718
271. Members ........................................................................................................................................... 724
272. Members ........................................................................................................................................... 727
273. Members ........................................................................................................................................... 732
274. Members ........................................................................................................................................... 736
275. Members ........................................................................................................................................... 739
276. Members ........................................................................................................................................... 742
277. Members ........................................................................................................................................... 748
278. Members ........................................................................................................................................... 751
279. Members ........................................................................................................................................... 755
280. Members ........................................................................................................................................... 762
281. Members ........................................................................................................................................... 771
282. Members ........................................................................................................................................... 775
283. Members ........................................................................................................................................... 806
284. Members ........................................................................................................................................... 815
285. Members ........................................................................................................................................... 818
286. Members ........................................................................................................................................... 824
287. Members ........................................................................................................................................... 832
288. Members ........................................................................................................................................... 835
289. Members ........................................................................................................................................... 838
290. Members ........................................................................................................................................... 843
291. Members ........................................................................................................................................... 846
292. Members ........................................................................................................................................... 848
293. Members ........................................................................................................................................... 853
294. Members ........................................................................................................................................... 856
295. Members ........................................................................................................................................... 861
296. Members ........................................................................................................................................... 866
297. Members ........................................................................................................................................... 869
298. Members ........................................................................................................................................... 880
299. Members ........................................................................................................................................... 881
300. Members ........................................................................................................................................... 886
301. Members ........................................................................................................................................... 889
302. Members ........................................................................................................................................... 892
303. Members ........................................................................................................................................... 895
304. Members ........................................................................................................................................... 905

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

305. Members ........................................................................................................................................... 911


306. Members ........................................................................................................................................... 915
307. Members ........................................................................................................................................... 923
308. Members ........................................................................................................................................... 924
309. Members ........................................................................................................................................... 926
310. Members ........................................................................................................................................... 935
311. Members ........................................................................................................................................... 938
312. Members ........................................................................................................................................... 942
313. Members ........................................................................................................................................... 944
314. Members ........................................................................................................................................... 946
315. Members ........................................................................................................................................... 949
316. Members ........................................................................................................................................... 951
317. Members ........................................................................................................................................... 956
318. Members ........................................................................................................................................... 966
319. Members ........................................................................................................................................... 968
320. Members ........................................................................................................................................... 971
321. Members ........................................................................................................................................... 972
322. Members ........................................................................................................................................... 975
323. Members ........................................................................................................................................... 977
324. Members ........................................................................................................................................... 984
325. Members ........................................................................................................................................... 988
326. Members ........................................................................................................................................... 991
327. Members ........................................................................................................................................... 995
328. Members ......................................................................................................................................... 1000
329. Members ......................................................................................................................................... 1007
330. Members ......................................................................................................................................... 1019
331. Members ......................................................................................................................................... 1026
332. Members ......................................................................................................................................... 1032
333. Members ......................................................................................................................................... 1036
334. Members ......................................................................................................................................... 1115
335. Members ......................................................................................................................................... 1130
336. Members ......................................................................................................................................... 1139
337. Members ......................................................................................................................................... 1164
338. Members ......................................................................................................................................... 1170
339. Members ......................................................................................................................................... 1173
340. Members ......................................................................................................................................... 1176
341. Members ......................................................................................................................................... 1179
342. Members ......................................................................................................................................... 1184
343. Members ......................................................................................................................................... 1189
344. Members ......................................................................................................................................... 1193
345. Members ......................................................................................................................................... 1195
346. Members ......................................................................................................................................... 1198
347. Members ......................................................................................................................................... 1205
348. Members ......................................................................................................................................... 1208
349. Members ......................................................................................................................................... 1212
350. Members ......................................................................................................................................... 1214
351. Members ......................................................................................................................................... 1216
352. Members ......................................................................................................................................... 1217
353. Members ......................................................................................................................................... 1220
354. Members ......................................................................................................................................... 1225
355. Members ......................................................................................................................................... 1232

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

356. Members ......................................................................................................................................... 1239


357. Members ......................................................................................................................................... 1242
358. Members ......................................................................................................................................... 1243
359. Members ......................................................................................................................................... 1246
360. Members ......................................................................................................................................... 1250
361. Members ......................................................................................................................................... 1262
362. Members ......................................................................................................................................... 1265
363. Members ......................................................................................................................................... 1269
364. Members ......................................................................................................................................... 1269
365. Members ......................................................................................................................................... 1270
366. Members ......................................................................................................................................... 1270
367. Members ......................................................................................................................................... 1273
368. Members ......................................................................................................................................... 1273
369. Members ......................................................................................................................................... 1275
370. Members ......................................................................................................................................... 1275
371. Members ......................................................................................................................................... 1276
372. Members ......................................................................................................................................... 1277
373. Members ......................................................................................................................................... 1279
374. Members ......................................................................................................................................... 1281
375. Members ......................................................................................................................................... 1282
376. Members ......................................................................................................................................... 1283
377. Members ......................................................................................................................................... 1284
378. Members ......................................................................................................................................... 1285
379. Members ......................................................................................................................................... 1286
380. Members ......................................................................................................................................... 1287
381. Members ......................................................................................................................................... 1288
382. Members ......................................................................................................................................... 1289
383. Members ......................................................................................................................................... 1290
384. Members ......................................................................................................................................... 1290
385. Members ......................................................................................................................................... 1291
386. Members ......................................................................................................................................... 1292
387. Members ......................................................................................................................................... 1294
388. Members ......................................................................................................................................... 1295
389. Members ......................................................................................................................................... 1296
390. Members ......................................................................................................................................... 1297
391. Members ......................................................................................................................................... 1298
392. Members ......................................................................................................................................... 1298
393. Members ......................................................................................................................................... 1299
394. Members ......................................................................................................................................... 1300
395. Members ......................................................................................................................................... 1301
396. Members ......................................................................................................................................... 1302
397. Members ......................................................................................................................................... 1303
398. Members ......................................................................................................................................... 1304
399. Members ......................................................................................................................................... 1305
400. Members ......................................................................................................................................... 1305
401. Members ......................................................................................................................................... 1306
402. Members ......................................................................................................................................... 1307
403. Members ......................................................................................................................................... 1308
404. Members ......................................................................................................................................... 1309
405. Members ......................................................................................................................................... 1309
406. Members ......................................................................................................................................... 1310

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

407. Members ......................................................................................................................................... 1312


408. Members ......................................................................................................................................... 1313
409. Members ......................................................................................................................................... 1314
410. Members ......................................................................................................................................... 1315
411. Members ......................................................................................................................................... 1316
412. Members ......................................................................................................................................... 1317
413. Members ......................................................................................................................................... 1317
414. Members ......................................................................................................................................... 1318
415. Members ......................................................................................................................................... 1318
416. Members ......................................................................................................................................... 1319
417. Members ......................................................................................................................................... 1321
418. Members ......................................................................................................................................... 1322
419. Members ......................................................................................................................................... 1323
420. Members ......................................................................................................................................... 1324
421. Members ......................................................................................................................................... 1325
422. Members ......................................................................................................................................... 1326
423. Members ......................................................................................................................................... 1328
424. Members ......................................................................................................................................... 1329
425. Members ......................................................................................................................................... 1331
426. Members ......................................................................................................................................... 1331
427. Members ......................................................................................................................................... 1332
428. Members ......................................................................................................................................... 1333
429. Members ......................................................................................................................................... 1333
430. Members ......................................................................................................................................... 1334
431. Members ......................................................................................................................................... 1335
432. Members ......................................................................................................................................... 1335
433. Members ......................................................................................................................................... 1337
434. Members ......................................................................................................................................... 1338
435. Members ......................................................................................................................................... 1341
436. Members ......................................................................................................................................... 1344
437. Members ......................................................................................................................................... 1348
438. Members ......................................................................................................................................... 1351
439. Members ......................................................................................................................................... 1353
440. Members ......................................................................................................................................... 1358
441. Members ......................................................................................................................................... 1362
442. Members ......................................................................................................................................... 1366
443. Members ......................................................................................................................................... 1370
444. Members ......................................................................................................................................... 1374
445. Members ......................................................................................................................................... 1378
446. Members ......................................................................................................................................... 1383
447. Members ......................................................................................................................................... 1398
448. Members ......................................................................................................................................... 1411
449. Members ......................................................................................................................................... 1414
450. Members ......................................................................................................................................... 1418
451. Members ......................................................................................................................................... 1422
452. Members ......................................................................................................................................... 1424
453. Members ......................................................................................................................................... 1427
454. Members ......................................................................................................................................... 1430
455. Members ......................................................................................................................................... 1437
456. Members ......................................................................................................................................... 1453
457. Members ......................................................................................................................................... 1458

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

458. Members ......................................................................................................................................... 1463


459. Members ......................................................................................................................................... 1463
460. Members ......................................................................................................................................... 1467
461. Members ......................................................................................................................................... 1470
462. Members ......................................................................................................................................... 1474
463. Members ......................................................................................................................................... 1478
464. Members ......................................................................................................................................... 1483
465. Members ......................................................................................................................................... 1484
466. Members ......................................................................................................................................... 1489
467. Members ......................................................................................................................................... 1494
468. Members ......................................................................................................................................... 1499
469. Members ......................................................................................................................................... 1505
470. Members ......................................................................................................................................... 1510
471. Members ......................................................................................................................................... 1515
472. Members ......................................................................................................................................... 1520
473. Members ......................................................................................................................................... 1526
474. Members ......................................................................................................................................... 1531
475. Members ......................................................................................................................................... 1536
476. Members ......................................................................................................................................... 1542
477. Members ......................................................................................................................................... 1547
478. Members ......................................................................................................................................... 1553
479. Members ......................................................................................................................................... 1558
480. Members ......................................................................................................................................... 1563
481. Members ......................................................................................................................................... 1568
482. Members ......................................................................................................................................... 1574
483. Members ......................................................................................................................................... 1580
484. Members ......................................................................................................................................... 1587
485. Members ......................................................................................................................................... 1593
486. Members ......................................................................................................................................... 1593
487. Members ......................................................................................................................................... 1602
488. Members ......................................................................................................................................... 1608
489. Members ......................................................................................................................................... 1614
490. Members ......................................................................................................................................... 1620
491. Members ......................................................................................................................................... 1625
492. Members ......................................................................................................................................... 1631
493. Members ......................................................................................................................................... 1637
494. Members ......................................................................................................................................... 1643
495. Members ......................................................................................................................................... 1648
496. Members ......................................................................................................................................... 1654
497. Members ......................................................................................................................................... 1660
498. Members ......................................................................................................................................... 1665
499. Members ......................................................................................................................................... 1666
500. Members ......................................................................................................................................... 1671
501. Members ......................................................................................................................................... 1675
502. Members ......................................................................................................................................... 1679
503. Members ......................................................................................................................................... 1684
504. Members ......................................................................................................................................... 1688
505. Members ......................................................................................................................................... 1693
506. Members ......................................................................................................................................... 1697
507. Members ......................................................................................................................................... 1702
508. Members ......................................................................................................................................... 1706

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

509. Members ......................................................................................................................................... 1710


510. Members ......................................................................................................................................... 1715
511. Members ......................................................................................................................................... 1719
512. Members ......................................................................................................................................... 1724
513. Members ......................................................................................................................................... 1728
514. Members ......................................................................................................................................... 1733
515. Members ......................................................................................................................................... 1733
516. Members ......................................................................................................................................... 1740
517. Members ......................................................................................................................................... 1745
518. Members ......................................................................................................................................... 1750
519. Members ......................................................................................................................................... 1755
520. Members ......................................................................................................................................... 1760
521. Members ......................................................................................................................................... 1765
522. Members ......................................................................................................................................... 1770
523. Members ......................................................................................................................................... 1775
524. Members ......................................................................................................................................... 1781
525. Members ......................................................................................................................................... 1781
526. Members ......................................................................................................................................... 1788
527. Members ......................................................................................................................................... 1794
528. Members ......................................................................................................................................... 1800
529. Members ......................................................................................................................................... 1806
530. Members ......................................................................................................................................... 1813
531. Members ......................................................................................................................................... 1819
532. Members ......................................................................................................................................... 1825
533. Members ......................................................................................................................................... 1831
534. Members ......................................................................................................................................... 1841
535. Members ......................................................................................................................................... 1841
536. Members ......................................................................................................................................... 1846
537. Members ......................................................................................................................................... 1850
538. Members ......................................................................................................................................... 1854
539. Members ......................................................................................................................................... 1859
540. Members ......................................................................................................................................... 1865
541. Members ......................................................................................................................................... 1865
542. Members ......................................................................................................................................... 1869
543. Members ......................................................................................................................................... 1874
544. Members ......................................................................................................................................... 1878
545. Members ......................................................................................................................................... 1882
546. Members ......................................................................................................................................... 1887
547. Members ......................................................................................................................................... 1887
548. Members ......................................................................................................................................... 1892
549. Members ......................................................................................................................................... 1896
550. Members ......................................................................................................................................... 1901
551. Members ......................................................................................................................................... 1905
552. Members ......................................................................................................................................... 1910
553. Members ......................................................................................................................................... 1911
554. Members ......................................................................................................................................... 1912
555. Members ......................................................................................................................................... 1916
556. Members ......................................................................................................................................... 1921
557. Members ......................................................................................................................................... 1925
558. Members ......................................................................................................................................... 1930
559. Members ......................................................................................................................................... 1935

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

560. Members ......................................................................................................................................... 1935


561. Members ......................................................................................................................................... 1940
562. Members ......................................................................................................................................... 1945
563. Members ......................................................................................................................................... 1950
564. Members ......................................................................................................................................... 1955
565. Members ......................................................................................................................................... 1960
566. Members ......................................................................................................................................... 1965
567. Members ......................................................................................................................................... 1969
568. Members ......................................................................................................................................... 1974
569. Members ......................................................................................................................................... 1979
570. Members ......................................................................................................................................... 1983
571. Members ......................................................................................................................................... 1989
572. Members ......................................................................................................................................... 1989
573. Members ......................................................................................................................................... 1994
574. Members ......................................................................................................................................... 1998
575. Members ......................................................................................................................................... 2002
576. Members ......................................................................................................................................... 2006
577. Members ......................................................................................................................................... 2011
578. Members ......................................................................................................................................... 2015
579. Members ......................................................................................................................................... 2019
580. Members ......................................................................................................................................... 2023
581. Members ......................................................................................................................................... 2029
582. Members ......................................................................................................................................... 2030
583. Members ......................................................................................................................................... 2036
584. Members ......................................................................................................................................... 2043
585. Members ......................................................................................................................................... 2049
586. Members ......................................................................................................................................... 2056
587. Members ......................................................................................................................................... 2063
588. Members ......................................................................................................................................... 2069
589. Members ......................................................................................................................................... 2076
590. Members ......................................................................................................................................... 2082
591. Members ......................................................................................................................................... 2089
592. Members ......................................................................................................................................... 2095
593. Members ......................................................................................................................................... 2102
594. Members ......................................................................................................................................... 2108
595. Members ......................................................................................................................................... 2115
596. Members ......................................................................................................................................... 2122
597. Members ......................................................................................................................................... 2129
598. Members ......................................................................................................................................... 2136
599. Members ......................................................................................................................................... 2143
600. Members ......................................................................................................................................... 2150
601. Members ......................................................................................................................................... 2156
602. Members ......................................................................................................................................... 2168
603. Members ......................................................................................................................................... 2174
604. Members ......................................................................................................................................... 2183
605. Members ......................................................................................................................................... 2183
606. Members ......................................................................................................................................... 2188
607. Members ......................................................................................................................................... 2192
608. Members ......................................................................................................................................... 2197
609. Members ......................................................................................................................................... 2201
610. Members ......................................................................................................................................... 2205

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

611. Members ......................................................................................................................................... 2210


612. Members ......................................................................................................................................... 2214
613. Members ......................................................................................................................................... 2219
614. Members ......................................................................................................................................... 2223
615. Members ......................................................................................................................................... 2229
616. Members ......................................................................................................................................... 2229
617. Members ......................................................................................................................................... 2234
618. Members ......................................................................................................................................... 2239
619. Members ......................................................................................................................................... 2243
620. Members ......................................................................................................................................... 2248
621. Members ......................................................................................................................................... 2252
622. Members ......................................................................................................................................... 2257
623. Members ......................................................................................................................................... 2261
624. Members ......................................................................................................................................... 2266
625. Members ......................................................................................................................................... 2271
626. Members ......................................................................................................................................... 2277
627. Members ......................................................................................................................................... 2277
628. Members ......................................................................................................................................... 2281
629. Members ......................................................................................................................................... 2286
630. Members ......................................................................................................................................... 2290
631. Members ......................................................................................................................................... 2296
632. Members ......................................................................................................................................... 2301
633. Members ......................................................................................................................................... 2301
634. Members ......................................................................................................................................... 2307
635. Members ......................................................................................................................................... 2311
636. Members ......................................................................................................................................... 2313
637. Members ......................................................................................................................................... 2317
638. Members ......................................................................................................................................... 2320
639. Members ......................................................................................................................................... 2326
640. Members ......................................................................................................................................... 2330
641. Members ......................................................................................................................................... 2334
642. Members ......................................................................................................................................... 2337
643. Members ......................................................................................................................................... 2341
644. Members ......................................................................................................................................... 2345
645. Members ......................................................................................................................................... 2349
646. Members ......................................................................................................................................... 2353
647. Members ......................................................................................................................................... 2356
648. Members ......................................................................................................................................... 2360
649. Members ......................................................................................................................................... 2364
650. Members ......................................................................................................................................... 2368
651. Members ......................................................................................................................................... 2371
652. Members ......................................................................................................................................... 2375
653. Members ......................................................................................................................................... 2379
654. Members ......................................................................................................................................... 2383
655. Members ......................................................................................................................................... 2387
656. Members ......................................................................................................................................... 2390
657. Members ......................................................................................................................................... 2394
658. Members ......................................................................................................................................... 2398
659. Members ......................................................................................................................................... 2402
660. Members ......................................................................................................................................... 2406
661. Members ......................................................................................................................................... 2409

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

662. Members ......................................................................................................................................... 2413


663. Members ......................................................................................................................................... 2417
664. Members ......................................................................................................................................... 2420
665. Members ......................................................................................................................................... 2424
666. Members ......................................................................................................................................... 2428
667. Members ......................................................................................................................................... 2432
668. Members ......................................................................................................................................... 2436
669. Members ......................................................................................................................................... 2439
670. Members ......................................................................................................................................... 2443
671. Members ......................................................................................................................................... 2447
672. Members ......................................................................................................................................... 2450
673. Members ......................................................................................................................................... 2454
674. Members ......................................................................................................................................... 2458
675. Members ......................................................................................................................................... 2461
676. Members ......................................................................................................................................... 2465
677. Members ......................................................................................................................................... 2469
678. Members ......................................................................................................................................... 2472
679. Members ......................................................................................................................................... 2476
680. Members ......................................................................................................................................... 2480
681. Members ......................................................................................................................................... 2485
682. Members ......................................................................................................................................... 2489
683. Members ......................................................................................................................................... 2494
684. Members ......................................................................................................................................... 2498
685. Members ......................................................................................................................................... 2502
686. Members ......................................................................................................................................... 2506
687. Members ......................................................................................................................................... 2509
688. Members ......................................................................................................................................... 2513
689. Members ......................................................................................................................................... 2518
690. Members ......................................................................................................................................... 2521
691. Members ......................................................................................................................................... 2526
692. Members ......................................................................................................................................... 2529
693. Members ......................................................................................................................................... 2535
694. Members ......................................................................................................................................... 2538
695. Members ......................................................................................................................................... 2542
696. Members ......................................................................................................................................... 2545
697. Members ......................................................................................................................................... 2549
698. Members ......................................................................................................................................... 2552
699. Members ......................................................................................................................................... 2557
700. Members ......................................................................................................................................... 2561
701. Members ......................................................................................................................................... 2565
702. Members ......................................................................................................................................... 2568
703. Members ......................................................................................................................................... 2572
704. Members ......................................................................................................................................... 2575
705. Members ......................................................................................................................................... 2579
706. Members ......................................................................................................................................... 2582
707. Members ......................................................................................................................................... 2587
708. Members ......................................................................................................................................... 2590
709. Members ......................................................................................................................................... 2595
710. Members ......................................................................................................................................... 2596
711. Members ......................................................................................................................................... 2600
712. Members ......................................................................................................................................... 2603

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

713. Members ......................................................................................................................................... 2606


714. Members ......................................................................................................................................... 2613
715. Members ......................................................................................................................................... 2622
716. Members ......................................................................................................................................... 2627
717. Members ......................................................................................................................................... 2632
718. Members ......................................................................................................................................... 2636
719. Members ......................................................................................................................................... 2640
720. Members ......................................................................................................................................... 2646
721. Members ......................................................................................................................................... 2650
722. Members ......................................................................................................................................... 2654
723. Members ......................................................................................................................................... 2659
724. Members ......................................................................................................................................... 2663
725. Members ......................................................................................................................................... 2673
726. Members ......................................................................................................................................... 2677
727. Members ......................................................................................................................................... 2682
728. Members ......................................................................................................................................... 2686
729. Members ......................................................................................................................................... 2693
730. Members ......................................................................................................................................... 2696
731. Members ......................................................................................................................................... 2700
732. Members ......................................................................................................................................... 2706
733. Members ......................................................................................................................................... 2711
734. Members ......................................................................................................................................... 2715
735. Members ......................................................................................................................................... 2720
736. Members ......................................................................................................................................... 2724
737. Members ......................................................................................................................................... 2730
738. Members ......................................................................................................................................... 2733
739. Members ......................................................................................................................................... 2738
740. Members ......................................................................................................................................... 2742
741. Members ......................................................................................................................................... 2746
742. Members ......................................................................................................................................... 2751
743. Members ......................................................................................................................................... 2764
744. Members ......................................................................................................................................... 2769
745. Members ......................................................................................................................................... 2775
746. Members ......................................................................................................................................... 2785
747. Members ......................................................................................................................................... 2796
748. Members ......................................................................................................................................... 2800
749. Members ......................................................................................................................................... 2804
750. Members ......................................................................................................................................... 2807
751. Members ......................................................................................................................................... 2813
752. Members ......................................................................................................................................... 2814
753. Members ......................................................................................................................................... 2817
754. Members ......................................................................................................................................... 2823
755. Members ......................................................................................................................................... 2827
756. Members ......................................................................................................................................... 2830
757. Members ......................................................................................................................................... 2834
758. Members ......................................................................................................................................... 2837
759. Members ......................................................................................................................................... 2841
760. Members ......................................................................................................................................... 2845
761. Members ......................................................................................................................................... 2849
762. Members ......................................................................................................................................... 2852
763. Members ......................................................................................................................................... 2856

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

764. Members ......................................................................................................................................... 2861


765. Members ......................................................................................................................................... 2866
766. Members ......................................................................................................................................... 2871
767. Members ......................................................................................................................................... 2876
768. Members ......................................................................................................................................... 2880
769. Members ......................................................................................................................................... 2884
770. Members ......................................................................................................................................... 2888
771. Members ......................................................................................................................................... 2892
772. Members ......................................................................................................................................... 2895
773. Members ......................................................................................................................................... 2899
774. Members ......................................................................................................................................... 2905
775. Members ......................................................................................................................................... 2911
776. Members ......................................................................................................................................... 2911
777. Members ......................................................................................................................................... 2915
778. Members ......................................................................................................................................... 2919
779. Members ......................................................................................................................................... 2923
780. Members ......................................................................................................................................... 2927
781. Members ......................................................................................................................................... 2936
782. Members ......................................................................................................................................... 2940
783. Members ......................................................................................................................................... 2946
784. Members ......................................................................................................................................... 2951
785. Members ......................................................................................................................................... 2952
786. Members ......................................................................................................................................... 2958
787. Members ......................................................................................................................................... 2959
788. Members ......................................................................................................................................... 2963
789. Members ......................................................................................................................................... 2967
790. Members ......................................................................................................................................... 2970
791. Members ......................................................................................................................................... 2971
792. Members ......................................................................................................................................... 2975
793. Members ......................................................................................................................................... 2976
794. Members ......................................................................................................................................... 2977
795. Members ......................................................................................................................................... 2978
796. Members ......................................................................................................................................... 2980
797. Members ......................................................................................................................................... 2986
798. Members ......................................................................................................................................... 2989
799. Members ......................................................................................................................................... 2994
800. Members ......................................................................................................................................... 2995
801. Members ......................................................................................................................................... 2995
802. Members ......................................................................................................................................... 2996
803. Members ......................................................................................................................................... 2999
804. Members ......................................................................................................................................... 2999
805. Members ......................................................................................................................................... 3004
806. Members ......................................................................................................................................... 3008
807. Members ......................................................................................................................................... 3012
808. Members ......................................................................................................................................... 3017
809. Members ......................................................................................................................................... 3017
810. Members ......................................................................................................................................... 3022
811. Members ......................................................................................................................................... 3027
812. Members ......................................................................................................................................... 3031
813. Members ......................................................................................................................................... 3035
814. Members ......................................................................................................................................... 3040

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

815. Members ......................................................................................................................................... 3044


816. Members ......................................................................................................................................... 3049
817. Members ......................................................................................................................................... 3049
818. Members ......................................................................................................................................... 3054
819. Members ......................................................................................................................................... 3058
820. Members ......................................................................................................................................... 3063
821. Members ......................................................................................................................................... 3067
822. Members ......................................................................................................................................... 3071
823. Members ......................................................................................................................................... 3076
824. Members ......................................................................................................................................... 3080
825. Members ......................................................................................................................................... 3084
826. Members ......................................................................................................................................... 3089
827. Members ......................................................................................................................................... 3093
828. Members ......................................................................................................................................... 3097
829. Members ......................................................................................................................................... 3102
830. Members ......................................................................................................................................... 3106
831. Members ......................................................................................................................................... 3110
832. Members ......................................................................................................................................... 3115
833. Members ......................................................................................................................................... 3116
834. Members ......................................................................................................................................... 3121
835. Members ......................................................................................................................................... 3126
836. Members ......................................................................................................................................... 3131
837. Members ......................................................................................................................................... 3136
838. Members ......................................................................................................................................... 3147
839. Members ......................................................................................................................................... 3154
840. Members ......................................................................................................................................... 3160
841. Members ......................................................................................................................................... 3165
842. Members ......................................................................................................................................... 3170
843. Members ......................................................................................................................................... 3175
844. Members ......................................................................................................................................... 3179
845. Members ......................................................................................................................................... 3184
846. Members ......................................................................................................................................... 3190
847. Members ......................................................................................................................................... 3196
848. Members ......................................................................................................................................... 3201
849. Members ......................................................................................................................................... 3205
850. Members ......................................................................................................................................... 3213
851. Members ......................................................................................................................................... 3214
852. Members ......................................................................................................................................... 3240
853. Members ......................................................................................................................................... 3242
854. Members ......................................................................................................................................... 3244
855. Members ......................................................................................................................................... 3246
856. Members ......................................................................................................................................... 3250
857. Members ......................................................................................................................................... 3252
858. Members ......................................................................................................................................... 3253
859. Members ......................................................................................................................................... 3257
860. Members ......................................................................................................................................... 3260
861. Members ......................................................................................................................................... 3320
862. Members ......................................................................................................................................... 3324
863. Members ......................................................................................................................................... 3327
864. Members ......................................................................................................................................... 3329
865. Members ......................................................................................................................................... 3330

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

866. Members ......................................................................................................................................... 3332


867. Members ......................................................................................................................................... 3342
868. Members ......................................................................................................................................... 3348
869. Members ......................................................................................................................................... 3349
870. Members ......................................................................................................................................... 3354
871. Members ......................................................................................................................................... 3399
872. Members ......................................................................................................................................... 3400
873. Members ......................................................................................................................................... 3404
874. Members ......................................................................................................................................... 3409
875. Members ......................................................................................................................................... 3413
876. Members ......................................................................................................................................... 3418
877. Members ......................................................................................................................................... 3422
878. Members ......................................................................................................................................... 3426
879. Members ......................................................................................................................................... 3430
880. Members ......................................................................................................................................... 3433
881. Members ......................................................................................................................................... 3436
882. Members ......................................................................................................................................... 3440
883. Members ......................................................................................................................................... 3443
884. Members ......................................................................................................................................... 3446
885. Members ......................................................................................................................................... 3450
886. Members ......................................................................................................................................... 3463
887. Members ......................................................................................................................................... 3475
888. Members ......................................................................................................................................... 3479
889. Members ......................................................................................................................................... 3483
890. Members ......................................................................................................................................... 3487
891. Members ......................................................................................................................................... 3491
892. Members ......................................................................................................................................... 3495
893. Members ......................................................................................................................................... 3499
894. Members ......................................................................................................................................... 3504
895. Members ......................................................................................................................................... 3508
896. Members ......................................................................................................................................... 3513
897. Members ......................................................................................................................................... 3513
898. Members ......................................................................................................................................... 3521
899. Members ......................................................................................................................................... 3522
900. Members ......................................................................................................................................... 3527
901. Members ......................................................................................................................................... 3537
902. Members ......................................................................................................................................... 3548
903. Members ......................................................................................................................................... 3554
904. Members ......................................................................................................................................... 3560
905. Members ......................................................................................................................................... 3571
906. Members ......................................................................................................................................... 3579
907. Members ......................................................................................................................................... 3604
908. Members ......................................................................................................................................... 3608
909. Members ......................................................................................................................................... 3627
910. Members ......................................................................................................................................... 3635
911. Members ......................................................................................................................................... 3641
912. Members ......................................................................................................................................... 3655
913. Members ......................................................................................................................................... 3655
914. Members ......................................................................................................................................... 3657
915. Members ......................................................................................................................................... 3657
916. Members ......................................................................................................................................... 3659

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

917. Members ......................................................................................................................................... 3662


918. Members ......................................................................................................................................... 3670
919. Members ......................................................................................................................................... 3672
920. Members ......................................................................................................................................... 3673
921. Members ......................................................................................................................................... 3677
922. Members ......................................................................................................................................... 3679
923. Members ......................................................................................................................................... 3680
924. Members ......................................................................................................................................... 3682
925. Members ......................................................................................................................................... 3684
926. Members ......................................................................................................................................... 3690
927. Members ......................................................................................................................................... 3692
928. Members ......................................................................................................................................... 3694
929. Members ......................................................................................................................................... 3695
930. Members ......................................................................................................................................... 3697
931. Members ......................................................................................................................................... 3702
932. Members ......................................................................................................................................... 3703
933. Members ......................................................................................................................................... 3704
934. Members ......................................................................................................................................... 3706
935. Members ......................................................................................................................................... 3707
936. Members ......................................................................................................................................... 3710
937. Members ......................................................................................................................................... 3713
938. Members ......................................................................................................................................... 3714
939. Members ......................................................................................................................................... 3716
940. Members ......................................................................................................................................... 3717
941. Members ......................................................................................................................................... 3723
942. Members ......................................................................................................................................... 3727
943. Members ......................................................................................................................................... 3731
944. Members ......................................................................................................................................... 3738
945. Members ......................................................................................................................................... 3740
946. Members ......................................................................................................................................... 3743
947. Members ......................................................................................................................................... 3745
948. Members ......................................................................................................................................... 3752
949. Members ......................................................................................................................................... 3756
950. Members ......................................................................................................................................... 3759
951. Members ......................................................................................................................................... 3762
952. Members ......................................................................................................................................... 3764
953. Members ......................................................................................................................................... 3766
954. Members ......................................................................................................................................... 3775
955. Members ......................................................................................................................................... 3779
956. Members ......................................................................................................................................... 3781
957. Members ......................................................................................................................................... 3782
958. Members ......................................................................................................................................... 3784
959. Members ......................................................................................................................................... 3788
960. Members ......................................................................................................................................... 3792
961. Members ......................................................................................................................................... 3794
962. Members ......................................................................................................................................... 3796
963. Members ......................................................................................................................................... 3800
964. Members ......................................................................................................................................... 3802
965. Members ......................................................................................................................................... 3811
966. Members ......................................................................................................................................... 3812
967. Members ......................................................................................................................................... 3818

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

968. Members ......................................................................................................................................... 3822


969. Members ......................................................................................................................................... 3825
970. Members ......................................................................................................................................... 3828
971. Members ......................................................................................................................................... 3832
972. Members ......................................................................................................................................... 3838
973. Members ......................................................................................................................................... 3840
974. Members ......................................................................................................................................... 3841
975. Members ......................................................................................................................................... 3844
976. Members ......................................................................................................................................... 3850
977. Members ......................................................................................................................................... 3853
978. Members ......................................................................................................................................... 3856
979. Members ......................................................................................................................................... 3862
980. Members ......................................................................................................................................... 3870
981. Members ......................................................................................................................................... 3872
982. Members ......................................................................................................................................... 3873
983. Members ......................................................................................................................................... 3882
984. Members ......................................................................................................................................... 3888
985. Members ......................................................................................................................................... 3894
986. Members ......................................................................................................................................... 3898
987. Members ......................................................................................................................................... 3903
988. Members ......................................................................................................................................... 3905
989. Members ......................................................................................................................................... 3913
990. Members ......................................................................................................................................... 3915
991. Members ......................................................................................................................................... 3920
992. Members ......................................................................................................................................... 3923
993. Members ......................................................................................................................................... 3924
994. Members ......................................................................................................................................... 3934
995. Members ......................................................................................................................................... 3935
996. Members ......................................................................................................................................... 3936
997. Members ......................................................................................................................................... 3937
998. Members ......................................................................................................................................... 3941
999. Members ......................................................................................................................................... 3943
1000. Members ....................................................................................................................................... 3947
1001. Members ....................................................................................................................................... 3954
1002. Members ....................................................................................................................................... 3963
1003. Members ....................................................................................................................................... 3969
1004. Members ....................................................................................................................................... 3973
1005. Members ....................................................................................................................................... 3977
1006. Members ....................................................................................................................................... 3981
1007. Members ....................................................................................................................................... 3983
1008. Members ....................................................................................................................................... 3985
1009. Members ....................................................................................................................................... 3990
1010. Members ....................................................................................................................................... 3992
1011. Members ....................................................................................................................................... 3993
1012. Members ....................................................................................................................................... 3995
1013. Members ....................................................................................................................................... 3999
1014. Members ....................................................................................................................................... 4004
1015. Members ....................................................................................................................................... 4008
1016. Members ....................................................................................................................................... 4009
1017. Members ....................................................................................................................................... 4012
1018. Members ....................................................................................................................................... 4014

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

1019. Members ....................................................................................................................................... 4017


1020. Members ....................................................................................................................................... 4017
1021. Members ....................................................................................................................................... 4021
1022. Members ....................................................................................................................................... 4133
1023. Members ....................................................................................................................................... 4169
1024. Members ....................................................................................................................................... 4181
1025. Members ....................................................................................................................................... 4189
1026. Members ....................................................................................................................................... 4190
1027. Members ....................................................................................................................................... 4203
1028. Members ....................................................................................................................................... 4211
1029. Members ....................................................................................................................................... 4218
1030. Members ....................................................................................................................................... 4223
1031. Members ....................................................................................................................................... 4227
1032. Members ....................................................................................................................................... 4231
1033. Members ....................................................................................................................................... 4231
1034. Members ....................................................................................................................................... 4234
1035. Members ....................................................................................................................................... 4241
1036. Members ....................................................................................................................................... 4242
1037. Members ....................................................................................................................................... 4247
1038. Members ....................................................................................................................................... 4247
1039. Members ....................................................................................................................................... 4253
1040. Members ....................................................................................................................................... 4255
1041. Members ....................................................................................................................................... 4259
1042. Members ....................................................................................................................................... 4260
1043. Members ....................................................................................................................................... 4260
1044. Members ....................................................................................................................................... 4261
1045. Members ....................................................................................................................................... 4262
1046. Members ....................................................................................................................................... 4262
1047. Members ....................................................................................................................................... 4263
1048. Members ....................................................................................................................................... 4264
1049. Members ....................................................................................................................................... 4265
1050. Members ....................................................................................................................................... 4265
1051. Members ....................................................................................................................................... 4266
1052. Members ....................................................................................................................................... 4267
1053. Members ....................................................................................................................................... 4268
1054. Members ....................................................................................................................................... 4268
1055. Members ....................................................................................................................................... 4269
1056. Members ....................................................................................................................................... 4269
1057. Members ....................................................................................................................................... 4271
1058. Members ....................................................................................................................................... 4273
1059. Members ....................................................................................................................................... 4273
1060. Members ....................................................................................................................................... 4274
1061. Members ....................................................................................................................................... 4274
1062. Members ....................................................................................................................................... 4274
1063. Members ....................................................................................................................................... 4275
1064. Members ....................................................................................................................................... 4277
1065. Members ....................................................................................................................................... 4277
1066. Members ....................................................................................................................................... 4278
1067. Members ....................................................................................................................................... 4278
1068. Members ....................................................................................................................................... 4279
1069. Members ....................................................................................................................................... 4279

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

1070. Members ....................................................................................................................................... 4281


1071. Members ....................................................................................................................................... 4281
1072. Members ....................................................................................................................................... 4282
1073. Members ....................................................................................................................................... 4283
1074. Members ....................................................................................................................................... 4284
1075. Members ....................................................................................................................................... 4285
1076. Members ....................................................................................................................................... 4285
1077. Members ....................................................................................................................................... 4289
1078. Members ....................................................................................................................................... 4289
1079. Members ....................................................................................................................................... 4289
1080. Members ....................................................................................................................................... 4290
1081. Members ....................................................................................................................................... 4290
1082. Members ....................................................................................................................................... 4291
1083. Members ....................................................................................................................................... 4292
1084. Members ....................................................................................................................................... 4293
1085. Members ....................................................................................................................................... 4293
1086. Members ....................................................................................................................................... 4294
1087. Members ....................................................................................................................................... 4294
1088. Members ....................................................................................................................................... 4294
1089. Members ....................................................................................................................................... 4295
1090. Members ....................................................................................................................................... 4295
1091. Members ....................................................................................................................................... 4296
1092. Members ....................................................................................................................................... 4297
1093. Members ....................................................................................................................................... 4297
1094. Members ....................................................................................................................................... 4298
1095. Members ....................................................................................................................................... 4298
1096. Members ....................................................................................................................................... 4299
1097. Members ....................................................................................................................................... 4301
1098. Members ....................................................................................................................................... 4301
1099. Members ....................................................................................................................................... 4302
1100. Members ....................................................................................................................................... 4302
1101. Members ....................................................................................................................................... 4303
1102. Members ....................................................................................................................................... 4305
1103. Members ....................................................................................................................................... 4305
1104. Members ....................................................................................................................................... 4306
1105. Members ....................................................................................................................................... 4306
1106. Members ....................................................................................................................................... 4306
1107. Members ....................................................................................................................................... 4307
1108. Members ....................................................................................................................................... 4307
1109. Members ....................................................................................................................................... 4309
1110. Members ....................................................................................................................................... 4309
1111. Members ....................................................................................................................................... 4310
1112. Members ....................................................................................................................................... 4310
1113. Members ....................................................................................................................................... 4313
1114. Members ....................................................................................................................................... 4313
1115. Members ....................................................................................................................................... 4315
1116. Members ....................................................................................................................................... 4315
1117. Members ....................................................................................................................................... 4317
1118. Members ....................................................................................................................................... 4317
1119. Members ....................................................................................................................................... 4319
1120. Members ....................................................................................................................................... 4335

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

1121. Members ....................................................................................................................................... 4336


1122. Members ....................................................................................................................................... 4336
1123. Members ....................................................................................................................................... 4336
1124. Members ....................................................................................................................................... 4336
1125. Members ....................................................................................................................................... 4337
1126. Members ....................................................................................................................................... 4337
1127. Members ....................................................................................................................................... 4337
1128. Members ....................................................................................................................................... 4338
1129. Members ....................................................................................................................................... 4338
1130. Members ....................................................................................................................................... 4338
1131. Members ....................................................................................................................................... 4339
1132. Members ....................................................................................................................................... 4339
1133. Members ....................................................................................................................................... 4339
1134. Members ....................................................................................................................................... 4340
1135. Members ....................................................................................................................................... 4340
1136. Members ....................................................................................................................................... 4340
1137. Members ....................................................................................................................................... 4341
1138. Members ....................................................................................................................................... 4341
1139. Members ....................................................................................................................................... 4341
1140. Members ....................................................................................................................................... 4342
1141. Members ....................................................................................................................................... 4342
1142. Members ....................................................................................................................................... 4342
1143. Members ....................................................................................................................................... 4342
1144. Members ....................................................................................................................................... 4343
1145. Members ....................................................................................................................................... 4343
1146. Members ....................................................................................................................................... 4344
1147. Members ....................................................................................................................................... 4344
1148. Members ....................................................................................................................................... 4344
1149. Members ....................................................................................................................................... 4345
1150. Members ....................................................................................................................................... 4345
1151. Members ....................................................................................................................................... 4345
1152. Members ....................................................................................................................................... 4346
1153. Members ....................................................................................................................................... 4346
1154. Members ....................................................................................................................................... 4346
1155. Members ....................................................................................................................................... 4347
1156. Members ....................................................................................................................................... 4347
1157. Members ....................................................................................................................................... 4348
1158. Members ....................................................................................................................................... 4348
1159. Members ....................................................................................................................................... 4348
1160. Members ....................................................................................................................................... 4349
1161. Members ....................................................................................................................................... 4349
1162. Members ....................................................................................................................................... 4349
1163. Members ....................................................................................................................................... 4350
1164. Members ....................................................................................................................................... 4350
1165. Members ....................................................................................................................................... 4350
1166. Members ....................................................................................................................................... 4351
1167. Members ....................................................................................................................................... 4351
1168. Members ....................................................................................................................................... 4351
1169. Members ....................................................................................................................................... 4352
1170. Members ....................................................................................................................................... 4352
1171. Members ....................................................................................................................................... 4352

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

1172. Members ....................................................................................................................................... 4353


1173. Members ....................................................................................................................................... 4353
1174. Members ....................................................................................................................................... 4353
1175. Members ....................................................................................................................................... 4354
1176. Members ....................................................................................................................................... 4354
1177. Members ....................................................................................................................................... 4354
1178. Members ....................................................................................................................................... 4355
1179. Members ....................................................................................................................................... 4355
1180. Members ....................................................................................................................................... 4355
1181. Members ....................................................................................................................................... 4356
1182. Members ....................................................................................................................................... 4356
1183. Members ....................................................................................................................................... 4356
1184. Members ....................................................................................................................................... 4357
1185. Members ....................................................................................................................................... 4357
1186. Members ....................................................................................................................................... 4358
1187. Members ....................................................................................................................................... 4358
1188. Members ....................................................................................................................................... 4358
1189. Members ....................................................................................................................................... 4359
1190. Members ....................................................................................................................................... 4359
1191. Members ....................................................................................................................................... 4359
1192. Members ....................................................................................................................................... 4360
1193. Members ....................................................................................................................................... 4360
1194. Members ....................................................................................................................................... 4360
1195. Members ....................................................................................................................................... 4361
1196. Members ....................................................................................................................................... 4361
1197. Members ....................................................................................................................................... 4361
1198. Members ....................................................................................................................................... 4362
1199. Members ....................................................................................................................................... 4362
1200. Members ....................................................................................................................................... 4362
1201. Members ....................................................................................................................................... 4362
1202. Members ....................................................................................................................................... 4363
1203. Members ....................................................................................................................................... 4363
1204. Members ....................................................................................................................................... 4363
1205. Members ....................................................................................................................................... 4364
1206. Members ....................................................................................................................................... 4364
1207. Members ....................................................................................................................................... 4364
1208. Members ....................................................................................................................................... 4365
1209. Members ....................................................................................................................................... 4365
1210. Members ....................................................................................................................................... 4365
1211. Members ....................................................................................................................................... 4366
1212. Members ....................................................................................................................................... 4366
1213. Members ....................................................................................................................................... 4366
1214. Members ....................................................................................................................................... 4367
1215. Members ....................................................................................................................................... 4367
1216. Members ....................................................................................................................................... 4367
1217. Members ....................................................................................................................................... 4368
1218. Members ....................................................................................................................................... 4368
1219. Members ....................................................................................................................................... 4368
1220. Members ....................................................................................................................................... 4369
1221. Members ....................................................................................................................................... 4369
1222. Members ....................................................................................................................................... 4369

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

1223. Members ....................................................................................................................................... 4370


1224. Members ....................................................................................................................................... 4370
1225. Members ....................................................................................................................................... 4370
1226. Members ....................................................................................................................................... 4371
1227. Members ....................................................................................................................................... 4371
1228. Members ....................................................................................................................................... 4371
1229. Members ....................................................................................................................................... 4372
1230. Members ....................................................................................................................................... 4372
1231. Members ....................................................................................................................................... 4372
1232. Members ....................................................................................................................................... 4373
1233. Members ....................................................................................................................................... 4373
1234. Members ....................................................................................................................................... 4373
1235. Members ....................................................................................................................................... 4374
1236. Members ....................................................................................................................................... 4374
1237. Members ....................................................................................................................................... 4374
1238. Members ....................................................................................................................................... 4375
1239. Members ....................................................................................................................................... 4375
1240. Members ....................................................................................................................................... 4375
1241. Members ....................................................................................................................................... 4376
1242. Members ....................................................................................................................................... 4376
1243. Members ....................................................................................................................................... 4376
1244. Members ....................................................................................................................................... 4377
1245. Members ....................................................................................................................................... 4377
1246. Members ....................................................................................................................................... 4377
1247. Members ....................................................................................................................................... 4378
1248. Members ....................................................................................................................................... 4378
1249. Members ....................................................................................................................................... 4378
1250. Members ....................................................................................................................................... 4379
1251. Members ....................................................................................................................................... 4379
1252. Members ....................................................................................................................................... 4379
1253. Members ....................................................................................................................................... 4380
1254. Members ....................................................................................................................................... 4380
1255. Members ....................................................................................................................................... 4380
1256. Members ....................................................................................................................................... 4381
1257. Members ....................................................................................................................................... 4381
1258. Members ....................................................................................................................................... 4381
1259. Members ....................................................................................................................................... 4382
1260. Members ....................................................................................................................................... 4382
1261. Members ....................................................................................................................................... 4383
1262. Members ....................................................................................................................................... 4383
1263. Members ....................................................................................................................................... 4402
1264. Members ....................................................................................................................................... 4403
1265. Members ....................................................................................................................................... 4403
1266. Members ....................................................................................................................................... 4403
1267. Members ....................................................................................................................................... 4404
1268. Members ....................................................................................................................................... 4404
1269. Members ....................................................................................................................................... 4404
1270. Members ....................................................................................................................................... 4405
1271. Members ....................................................................................................................................... 4405
1272. Members ....................................................................................................................................... 4405
1273. Members ....................................................................................................................................... 4406

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

1274. Members ....................................................................................................................................... 4406


1275. Members ....................................................................................................................................... 4406
1276. Members ....................................................................................................................................... 4407
1277. Members ....................................................................................................................................... 4407
1278. Members ....................................................................................................................................... 4407
1279. Members ....................................................................................................................................... 4408
1280. Members ....................................................................................................................................... 4408
1281. Members ....................................................................................................................................... 4409
1282. Members ....................................................................................................................................... 4409
1283. Members ....................................................................................................................................... 4409
1284. Members ....................................................................................................................................... 4410
1285. Members ....................................................................................................................................... 4410
1286. Members ....................................................................................................................................... 4410
1287. Members ....................................................................................................................................... 4411
1288. Members ....................................................................................................................................... 4411
1289. Members ....................................................................................................................................... 4411
1290. Members ....................................................................................................................................... 4412
1291. Members ....................................................................................................................................... 4412
1292. Members ....................................................................................................................................... 4412
1293. Members ....................................................................................................................................... 4413
1294. Members ....................................................................................................................................... 4413
1295. Members ....................................................................................................................................... 4413
1296. Members ....................................................................................................................................... 4414
1297. Members ....................................................................................................................................... 4414
1298. Members ....................................................................................................................................... 4414
1299. Members ....................................................................................................................................... 4415
1300. Members ....................................................................................................................................... 4415
1301. Members ....................................................................................................................................... 4415
1302. Members ....................................................................................................................................... 4416
1303. Members ....................................................................................................................................... 4416
1304. Members ....................................................................................................................................... 4416
1305. Members ....................................................................................................................................... 4417
1306. Members ....................................................................................................................................... 4417
1307. Members ....................................................................................................................................... 4417
1308. Members ....................................................................................................................................... 4418
1309. Members ....................................................................................................................................... 4418
1310. Members ....................................................................................................................................... 4418
1311. Members ....................................................................................................................................... 4419
1312. Members ....................................................................................................................................... 4419
1313. Members ....................................................................................................................................... 4419
1314. Members ....................................................................................................................................... 4420
1315. Members ....................................................................................................................................... 4420
1316. Members ....................................................................................................................................... 4420
1317. Members ....................................................................................................................................... 4421
1318. Members ....................................................................................................................................... 4421
1319. Members ....................................................................................................................................... 4421
1320. Members ....................................................................................................................................... 4422
1321. Members ....................................................................................................................................... 4422
1322. Members ....................................................................................................................................... 4423
1323. Members ....................................................................................................................................... 4423
1324. Members ....................................................................................................................................... 4423

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

1325. Members ....................................................................................................................................... 4424


1326. Members ....................................................................................................................................... 4424
1327. Members ....................................................................................................................................... 4424
1328. Members ....................................................................................................................................... 4425
1329. Members ....................................................................................................................................... 4425
1330. Members ....................................................................................................................................... 4425
1331. Members ....................................................................................................................................... 4426
1332. Members ....................................................................................................................................... 4426
1333. Members ....................................................................................................................................... 4426
1334. Members ....................................................................................................................................... 4427
1335. Members ....................................................................................................................................... 4427
1336. Members ....................................................................................................................................... 4427
1337. Members ....................................................................................................................................... 4428
1338. Members ....................................................................................................................................... 4428
1339. Members ....................................................................................................................................... 4428
1340. Members ....................................................................................................................................... 4429
1341. Members ....................................................................................................................................... 4429
1342. Members ....................................................................................................................................... 4429
1343. Members ....................................................................................................................................... 4429
1344. Members ....................................................................................................................................... 4430
1345. Members ....................................................................................................................................... 4431
1346. Members ....................................................................................................................................... 4431
1347. Members ....................................................................................................................................... 4431
1348. Members ....................................................................................................................................... 4432
1349. Members ....................................................................................................................................... 4432
1350. Members ....................................................................................................................................... 4432
1351. Members ....................................................................................................................................... 4433
1352. Members ....................................................................................................................................... 4433
1353. Members ....................................................................................................................................... 4433
1354. Members ....................................................................................................................................... 4434
1355. Members ....................................................................................................................................... 4434
1356. Members ....................................................................................................................................... 4435
1357. Members ....................................................................................................................................... 4435
1358. Members ....................................................................................................................................... 4435
1359. Members ....................................................................................................................................... 4436
1360. Members ....................................................................................................................................... 4436
1361. Members ....................................................................................................................................... 4436
1362. Members ....................................................................................................................................... 4437
1363. Members ....................................................................................................................................... 4437
1364. Members ....................................................................................................................................... 4437
1365. Members ....................................................................................................................................... 4438
1366. Members ....................................................................................................................................... 4438
1367. Members ....................................................................................................................................... 4438
1368. Members ....................................................................................................................................... 4438
1369. Members ....................................................................................................................................... 4439
1370. Members ....................................................................................................................................... 4439
1371. Members ....................................................................................................................................... 4439
1372. Members ....................................................................................................................................... 4440
1373. Members ....................................................................................................................................... 4440
1374. Members ....................................................................................................................................... 4440
1375. Members ....................................................................................................................................... 4441

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

1376. Members ....................................................................................................................................... 4441


1377. Members ....................................................................................................................................... 4441
1378. Members ....................................................................................................................................... 4442
1379. Members ....................................................................................................................................... 4442
1380. Members ....................................................................................................................................... 4443
1381. Members ....................................................................................................................................... 4443
1382. Members ....................................................................................................................................... 4443
1383. Members ....................................................................................................................................... 4443
1384. Members ....................................................................................................................................... 4444
1385. Members ....................................................................................................................................... 4445
1386. Members ....................................................................................................................................... 4445
1387. Members ....................................................................................................................................... 4445
1388. Members ....................................................................................................................................... 4446
1389. Members ....................................................................................................................................... 4446
1390. Members ....................................................................................................................................... 4447
1391. Members ....................................................................................................................................... 4447
1392. Members ....................................................................................................................................... 4447
1393. Members ....................................................................................................................................... 4448
1394. Members ....................................................................................................................................... 4448
1395. Members ....................................................................................................................................... 4448
1396. Members ....................................................................................................................................... 4449
1397. Members ....................................................................................................................................... 4449
1398. Members ....................................................................................................................................... 4449
1399. Members ....................................................................................................................................... 4450
1400. Members ....................................................................................................................................... 4450
1401. Members ....................................................................................................................................... 4450
1402. Members ....................................................................................................................................... 4451
1403. Members ....................................................................................................................................... 4451
1404. Members ....................................................................................................................................... 4451
1405. Members ....................................................................................................................................... 4452
1406. Members ....................................................................................................................................... 4452
1407. Members ....................................................................................................................................... 4452
1408. Members ....................................................................................................................................... 4453
1409. Members ....................................................................................................................................... 4453
1410. Members ....................................................................................................................................... 4454
1411. Members ....................................................................................................................................... 4454
1412. Members ....................................................................................................................................... 4454
1413. Members ....................................................................................................................................... 4455
1414. Members ....................................................................................................................................... 4455
1415. Members ....................................................................................................................................... 4455
1416. Members ....................................................................................................................................... 4456
1417. Members ....................................................................................................................................... 4456
1418. Members ....................................................................................................................................... 4456
1419. Members ....................................................................................................................................... 4457
1420. Members ....................................................................................................................................... 4457
1421. Members ....................................................................................................................................... 4457
1422. Members ....................................................................................................................................... 4458
1423. Members ....................................................................................................................................... 4458
1424. Members ....................................................................................................................................... 4458
1425. Members ....................................................................................................................................... 4459
1426. Members ....................................................................................................................................... 4459

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

1427. Members ....................................................................................................................................... 4459


1428. Members ....................................................................................................................................... 4460
1429. Members ....................................................................................................................................... 4460
1430. Members ....................................................................................................................................... 4461
1431. Members ....................................................................................................................................... 4461
1432. Members ....................................................................................................................................... 4462
1433. Members ....................................................................................................................................... 4462
1434. Members ....................................................................................................................................... 4463
1435. Members ....................................................................................................................................... 4463
1436. Members ....................................................................................................................................... 4463
1437. Members ....................................................................................................................................... 4464
1438. Members ....................................................................................................................................... 4464
1439. Members ....................................................................................................................................... 4464
1440. Members ....................................................................................................................................... 4465
1441. Members ....................................................................................................................................... 4465
1442. Members ....................................................................................................................................... 4465
1443. Members ....................................................................................................................................... 4466
1444. Members ....................................................................................................................................... 4466
1445. Members ....................................................................................................................................... 4466
1446. Members ....................................................................................................................................... 4467
1447. Members ....................................................................................................................................... 4467
1448. Members ....................................................................................................................................... 4467
1449. Members ....................................................................................................................................... 4468
1450. Members ....................................................................................................................................... 4472
1451. Members ....................................................................................................................................... 4473
1452. Members ....................................................................................................................................... 4473
1453. Members ....................................................................................................................................... 4473
1454. Members ....................................................................................................................................... 4474
1455. Members ....................................................................................................................................... 4474
1456. Members ....................................................................................................................................... 4474
1457. Members ....................................................................................................................................... 4475
1458. Members ....................................................................................................................................... 4475
1459. Members ....................................................................................................................................... 4476
1460. Members ....................................................................................................................................... 4476
1461. Members ....................................................................................................................................... 4476
1462. Members ....................................................................................................................................... 4477
1463. Members ....................................................................................................................................... 4477
1464. Members ....................................................................................................................................... 4478
1465. Members ....................................................................................................................................... 4478
1466. Members ....................................................................................................................................... 4479
1467. Members ....................................................................................................................................... 4479
1468. Members ....................................................................................................................................... 4480
1469. Members ....................................................................................................................................... 4480
1470. Members ....................................................................................................................................... 4481
1471. Members ....................................................................................................................................... 4481
1472. Members ....................................................................................................................................... 4482
1473. Members ....................................................................................................................................... 4482
1474. Members ....................................................................................................................................... 4483
1475. Members ....................................................................................................................................... 4484
1476. Members ....................................................................................................................................... 4484
1477. Members ....................................................................................................................................... 4484

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

1478. Members ....................................................................................................................................... 4485


1479. Members ....................................................................................................................................... 4485
1480. Members ....................................................................................................................................... 4486
1481. Members ....................................................................................................................................... 4486
1482. Members ....................................................................................................................................... 4486
1483. Members ....................................................................................................................................... 4487
1484. Members ....................................................................................................................................... 4487
1485. Members ....................................................................................................................................... 4487
1486. Members ....................................................................................................................................... 4488
1487. Members ....................................................................................................................................... 4488
1488. Members ....................................................................................................................................... 4488
1489. Members ....................................................................................................................................... 4489
1490. Members ....................................................................................................................................... 4489
1491. Members ....................................................................................................................................... 4489
1492. Members ....................................................................................................................................... 4490
1493. Members ....................................................................................................................................... 4490
1494. Members ....................................................................................................................................... 4491
1495. Members ....................................................................................................................................... 4491
1496. Members ....................................................................................................................................... 4492
1497. Members ....................................................................................................................................... 4492
1498. Members ....................................................................................................................................... 4492
1499. Members ....................................................................................................................................... 4493
1500. Members ....................................................................................................................................... 4493
1501. Members ....................................................................................................................................... 4493
1502. Members ....................................................................................................................................... 4494
1503. Members ....................................................................................................................................... 4494
1504. Members ....................................................................................................................................... 4494
1505. Members ....................................................................................................................................... 4495
1506. Members ....................................................................................................................................... 4495
1507. Members ....................................................................................................................................... 4495
1508. Members ....................................................................................................................................... 4496
1509. Members ....................................................................................................................................... 4496
1510. Members ....................................................................................................................................... 4496
1511. Members ....................................................................................................................................... 4496
1512. Members ....................................................................................................................................... 4497
1513. Members ....................................................................................................................................... 4497
1514. Members ....................................................................................................................................... 4497
1515. Members ....................................................................................................................................... 4498
1516. Members ....................................................................................................................................... 4498
1517. Members ....................................................................................................................................... 4498
1518. Members ....................................................................................................................................... 4499
1519. Members ....................................................................................................................................... 4499
1520. Members ....................................................................................................................................... 4499
1521. Members ....................................................................................................................................... 4500
1522. Members ....................................................................................................................................... 4501
1523. Members ....................................................................................................................................... 4501
1524. Members ....................................................................................................................................... 4501
1525. Members ....................................................................................................................................... 4502
1526. Members ....................................................................................................................................... 4502
1527. Members ....................................................................................................................................... 4502
1528. Members ....................................................................................................................................... 4503

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

1529. Members ....................................................................................................................................... 4503


1530. Members ....................................................................................................................................... 4503
1531. Members ....................................................................................................................................... 4504
1532. Members ....................................................................................................................................... 4504
1533. Members ....................................................................................................................................... 4504
1534. Members ....................................................................................................................................... 4505
1535. Members ....................................................................................................................................... 4505
1536. Members ....................................................................................................................................... 4505
1537. Members ....................................................................................................................................... 4506
1538. Members ....................................................................................................................................... 4506
1539. Members ....................................................................................................................................... 4506
1540. Members ....................................................................................................................................... 4507
1541. Members ....................................................................................................................................... 4507
1542. Members ....................................................................................................................................... 4507
1543. Members ....................................................................................................................................... 4508
1544. Members ....................................................................................................................................... 4508
1545. Members ....................................................................................................................................... 4508
1546. Members ....................................................................................................................................... 4509
1547. Members ....................................................................................................................................... 4509
1548. Members ....................................................................................................................................... 4509
1549. Members ....................................................................................................................................... 4509
1550. Members ....................................................................................................................................... 4510
1551. Members ....................................................................................................................................... 4510
1552. Members ....................................................................................................................................... 4510
1553. Members ....................................................................................................................................... 4511
1554. Members ....................................................................................................................................... 4512
1555. Members ....................................................................................................................................... 4513
1556. Members ....................................................................................................................................... 4514
1557. Members ....................................................................................................................................... 4515
1558. Members ....................................................................................................................................... 4515
1559. Members ....................................................................................................................................... 4515
1560. Members ....................................................................................................................................... 4516
1561. Members ....................................................................................................................................... 4516
1562. Members ....................................................................................................................................... 4516
1563. Members ....................................................................................................................................... 4517
1564. Members ....................................................................................................................................... 4517
1565. Members ....................................................................................................................................... 4518
1566. Members ....................................................................................................................................... 4518
1567. Members ....................................................................................................................................... 4518
1568. Members ....................................................................................................................................... 4519
1569. Members ....................................................................................................................................... 4519
1570. Members ....................................................................................................................................... 4519
1571. Members ....................................................................................................................................... 4520
1572. Members ....................................................................................................................................... 4520
1573. Members ....................................................................................................................................... 4520
1574. Members ....................................................................................................................................... 4521
1575. Members ....................................................................................................................................... 4521
1576. Members ....................................................................................................................................... 4522
1577. Members ....................................................................................................................................... 4522
1578. Members ....................................................................................................................................... 4522
1579. Members ....................................................................................................................................... 4523

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

1580. Members ....................................................................................................................................... 4523


1581. Members ....................................................................................................................................... 4523
1582. Members ....................................................................................................................................... 4524
1583. Members ....................................................................................................................................... 4524
1584. Members ....................................................................................................................................... 4524
1585. Members ....................................................................................................................................... 4525
1586. Members ....................................................................................................................................... 4525
1587. Members ....................................................................................................................................... 4525
1588. Members ....................................................................................................................................... 4526
1589. Members ....................................................................................................................................... 4526
1590. Members ....................................................................................................................................... 4526
1591. Members ....................................................................................................................................... 4527
1592. Members ....................................................................................................................................... 4527
1593. Members ....................................................................................................................................... 4527
1594. Members ....................................................................................................................................... 4528
1595. Members ....................................................................................................................................... 4528
1596. Members ....................................................................................................................................... 4536
1597. Members ....................................................................................................................................... 4537
1598. Members ....................................................................................................................................... 4537
1599. Members ....................................................................................................................................... 4537
1600. Members ....................................................................................................................................... 4538
1601. Members ....................................................................................................................................... 4538
1602. Members ....................................................................................................................................... 4538
1603. Members ....................................................................................................................................... 4539
1604. Members ....................................................................................................................................... 4539
1605. Members ....................................................................................................................................... 4539
1606. Members ....................................................................................................................................... 4540
1607. Members ....................................................................................................................................... 4540
1608. Members ....................................................................................................................................... 4540
1609. Members ....................................................................................................................................... 4541
1610. Members ....................................................................................................................................... 4541
1611. Members ....................................................................................................................................... 4545
1612. Members ....................................................................................................................................... 4545
1613. Members ....................................................................................................................................... 4546
1614. Members ....................................................................................................................................... 4546
1615. Members ....................................................................................................................................... 4547
1616. Members ....................................................................................................................................... 4547
1617. Members ....................................................................................................................................... 4548
1618. Members ....................................................................................................................................... 4548
1619. Members ....................................................................................................................................... 4548
1620. Members ....................................................................................................................................... 4549
1621. Members ....................................................................................................................................... 4549
1622. Members ....................................................................................................................................... 4549
1623. Members ....................................................................................................................................... 4550
1624. Members ....................................................................................................................................... 4550
1625. Members ....................................................................................................................................... 4550
1626. Members ....................................................................................................................................... 4551
1627. Members ....................................................................................................................................... 4551
1628. Members ....................................................................................................................................... 4551
1629. Members ....................................................................................................................................... 4552
1630. Members ....................................................................................................................................... 4552

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

1631. Members ....................................................................................................................................... 4552


1632. Members ....................................................................................................................................... 4553
1633. Members ....................................................................................................................................... 4553
1634. Members ....................................................................................................................................... 4554
1635. Members ....................................................................................................................................... 4555
1636. Members ....................................................................................................................................... 4555
1637. Members ....................................................................................................................................... 4555
1638. Members ....................................................................................................................................... 4556
1639. Members ....................................................................................................................................... 4556
1640. Members ....................................................................................................................................... 4556
1641. Members ....................................................................................................................................... 4557
1642. Members ....................................................................................................................................... 4557
1643. Members ....................................................................................................................................... 4557
1644. Members ....................................................................................................................................... 4558
1645. Members ....................................................................................................................................... 4558
1646. Members ....................................................................................................................................... 4558
1647. Members ....................................................................................................................................... 4558
1648. Members ....................................................................................................................................... 4559
1649. Members ....................................................................................................................................... 4559
1650. Members ....................................................................................................................................... 4559
1651. Members ....................................................................................................................................... 4560
1652. Members ....................................................................................................................................... 4560
1653. Members ....................................................................................................................................... 4560
1654. Members ....................................................................................................................................... 4561
1655. Members ....................................................................................................................................... 4561
1656. Members ....................................................................................................................................... 4561
1657. Members ....................................................................................................................................... 4562
1658. Members ....................................................................................................................................... 4562
1659. Members ....................................................................................................................................... 4562
1660. Members ....................................................................................................................................... 4562
1661. Members ....................................................................................................................................... 4563
1662. Members ....................................................................................................................................... 4563
1663. Members ....................................................................................................................................... 4563
1664. Members ....................................................................................................................................... 4564
1665. Members ....................................................................................................................................... 4564
1666. Members ....................................................................................................................................... 4564
1667. Members ....................................................................................................................................... 4565
1668. Members ....................................................................................................................................... 4565
1669. Members ....................................................................................................................................... 4565
1670. Members ....................................................................................................................................... 4566
1671. Members ....................................................................................................................................... 4566
1672. Members ....................................................................................................................................... 4566
1673. Members ....................................................................................................................................... 4567
1674. Members ....................................................................................................................................... 4567
1675. Members ....................................................................................................................................... 4567
1676. Members ....................................................................................................................................... 4568
1677. Members ....................................................................................................................................... 4568
1678. Members ....................................................................................................................................... 4568
1679. Members ....................................................................................................................................... 4569
1680. Members ....................................................................................................................................... 4569
1681. Members ....................................................................................................................................... 4569

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

1682. Members ....................................................................................................................................... 4570


1683. Members ....................................................................................................................................... 4570
1684. Members ....................................................................................................................................... 4570
1685. Members ....................................................................................................................................... 4571
1686. Members ....................................................................................................................................... 4571
1687. Members ....................................................................................................................................... 4571
1688. Members ....................................................................................................................................... 4572
1689. Members ....................................................................................................................................... 4572
1690. Members ....................................................................................................................................... 4572
1691. Members ....................................................................................................................................... 4573
1692. Members ....................................................................................................................................... 4573
1693. Members ....................................................................................................................................... 4573
1694. Members ....................................................................................................................................... 4574
1695. Members ....................................................................................................................................... 4574
1696. Members ....................................................................................................................................... 4574
1697. Members ....................................................................................................................................... 4575
1698. Members ....................................................................................................................................... 4575
1699. Members ....................................................................................................................................... 4575
1700. Members ....................................................................................................................................... 4576
1701. Members ....................................................................................................................................... 4576
1702. Members ....................................................................................................................................... 4576
1703. Members ....................................................................................................................................... 4576
1704. Members ....................................................................................................................................... 4577
1705. Members ....................................................................................................................................... 4577
1706. Members ....................................................................................................................................... 4577
1707. Members ....................................................................................................................................... 4578
1708. Members ....................................................................................................................................... 4578
1709. Members ....................................................................................................................................... 4579
1710. Members ....................................................................................................................................... 4579
1711. Members ....................................................................................................................................... 4579
1712. Members ....................................................................................................................................... 4583
1713. Members ....................................................................................................................................... 4583
1714. Members ....................................................................................................................................... 4584
1715. Members ....................................................................................................................................... 4584
1716. Members ....................................................................................................................................... 4584
1717. Members ....................................................................................................................................... 4585
1718. Members ....................................................................................................................................... 4585
1719. Members ....................................................................................................................................... 4586
1720. Members ....................................................................................................................................... 4586
1721. Members ....................................................................................................................................... 4586
1722. Members ....................................................................................................................................... 4587
1723. Members ....................................................................................................................................... 4587
1724. Members ....................................................................................................................................... 4588
1725. Members ....................................................................................................................................... 4588
1726. Members ....................................................................................................................................... 4588
1727. Members ....................................................................................................................................... 4589
1728. Members ....................................................................................................................................... 4589
1729. Members ....................................................................................................................................... 4590
1730. Members ....................................................................................................................................... 4590
1731. Members ....................................................................................................................................... 4591
1732. Members ....................................................................................................................................... 4591

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

1733. Members ....................................................................................................................................... 4592


1734. Members ....................................................................................................................................... 4592
1735. Members ....................................................................................................................................... 4593
1736. Members ....................................................................................................................................... 4593
1737. Members ....................................................................................................................................... 4594
1738. Members ....................................................................................................................................... 4594
1739. Members ....................................................................................................................................... 4594
1740. Members ....................................................................................................................................... 4595
1741. Members ....................................................................................................................................... 4595
1742. Members ....................................................................................................................................... 4596
1743. Members ....................................................................................................................................... 4596
1744. Members ....................................................................................................................................... 4597
1745. Members ....................................................................................................................................... 4597
1746. Members ....................................................................................................................................... 4599
1747. Members ....................................................................................................................................... 4599
1748. Members ....................................................................................................................................... 4603
1749. Members ....................................................................................................................................... 4603
1750. Members ....................................................................................................................................... 4604
1751. Members ....................................................................................................................................... 4610
1752. Members ....................................................................................................................................... 4611
1753. Members ....................................................................................................................................... 4613
1754. Members ....................................................................................................................................... 4614
1755. Members ....................................................................................................................................... 4615
1756. Members ....................................................................................................................................... 4615
1757. Members ....................................................................................................................................... 4622
1758. Members ....................................................................................................................................... 4624
1759. Members ....................................................................................................................................... 4626
1760. Members ....................................................................................................................................... 4627
1761. Members ....................................................................................................................................... 4627
1762. Members ....................................................................................................................................... 4635
1763. Members ....................................................................................................................................... 4635
1764. Members ....................................................................................................................................... 4642
1765. Members ....................................................................................................................................... 4648
1766. Members ....................................................................................................................................... 4655
1767. Members ....................................................................................................................................... 4655
1768. Members ....................................................................................................................................... 4656
1769. Members ....................................................................................................................................... 4657
1770. Members ....................................................................................................................................... 4665
1771. Members ....................................................................................................................................... 4670
1772. Members ....................................................................................................................................... 4676

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ccxciii
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
ccxciv of ANSYS, Inc. and its subsidiaries and affiliates.
Namespaces
Ansys.ACT.Core Namespace
Declaration Syntax
namespace Ansys.ACT.Core

Table 1: Members

ExtensionId (p. 3) Provides service to uniquely identify the extension.


ProcessUtilities (p. 3) This class exposes process-based utility methods used to run external
applications.

ExtensionId
Provides service to uniquely identify the extension.

Declaration Syntax
public class ExtensionId

Table 2: Members

Property UniqueId (p. 3) Get the unique id of the


extension.

UniqueId
Get the unique id of the extension.

Declaration Syntax
public string UniqueId { get; }

ProcessUtilities
This class exposes process-based utility methods used to run external applications.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
Ansys.ACT.Core Namespace

Declaration Syntax
public class ProcessUtilities : IProcessUtilities

Table 3: Members

Method Start(string, params string[]) (p. 4) Starts an application, file, or other


target.
Method Start(string, bool, params string[]) (p. 4) Starts an application, file, or other
target.

Start(string, params string[])


Starts an application, file, or other target.

Declaration Syntax
public virtual int Start(string target, params string[] args)

Parameters
target(string)

The fully-qualified path to the application, file, or other target

args(string[])

Command line arguments

Start(string, bool, params string[])


Starts an application, file, or other target.

Declaration Syntax
public virtual int Start(string target, bool useShell, params string[] args)

Parameters
target(string)

The fully-qualified path to the application, file, or other target

useShell(bool)

Indicates whether or not to execute the target using the OS shell

args(string[])

Command line arguments

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Core.Application.DataModel Namespace
Declaration Syntax
namespace Ansys.ACT.Core.Application.DataModel

Table 4: Members

IDataModelProvider (p. 5) No details are provided for this


entry.

IDataModelProvider
No details are provided for this entry.

Declaration Syntax
public interface IDataModelProvider

Table 5: Members

Property DataModel (p. 5) No details are provided for this


entry.

DataModel
No details are provided for this entry.

Declaration Syntax
public object DataModel { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Core.Utilities Namespace
Declaration Syntax
namespace Ansys.ACT.Core.Utilities

Table 6: Members

AttributeCollection (p. 7) A collection of attributes.


NamedCollection<T> (p. 10) Represents a collection of INamed objects that could be found by its
Name field.

AttributeCollection
A collection of attributes.

Declaration Syntax
public class AttributeCollection : IEnumerable<KeyValuePair<string, object>>, IEnumerable, ISerializable,
IAttributeCollection

Table 7: Members

Property Item (p. 7) Get or set an attribute value.


Property Keys (p. 8) The list of the available keys in the collection.
Method Clone() (p. 8) Create a clone of the currection collection.
Method Contains(string) (p. 8) Check if the collection contains an attribute.
Method GetStringValue(string) (p. 8) Gets an attribute value by its name.
Method GetValue(string) (p. 8) Gets an attribute value by its name.
Method GetValue(string, object) (p. 9) Gets an attribute value by its name.
Method Remove(string) (p. 9) Remove an attribute. The attribute cannot be removed if
it was declared as static attribute.
Method SetValue(string, object) (p. 9) Set an attribute value.

Item(string)
Get or set an attribute value.

Declaration Syntax
public object Item { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
Ansys.ACT.Core.Utilities Namespace

Keys
The list of the available keys in the collection.

Declaration Syntax
public ICollection<string> Keys { get; }

Clone()
Create a clone of the currection collection.

Declaration Syntax
public AttributeCollection Clone()

Contains(string)
Check if the collection contains an attribute.

Declaration Syntax
public virtual bool Contains(string name)

Parameters
name(string)

The attribute name.

GetStringValue(string)
Gets an attribute value by its name.

Declaration Syntax
public virtual string GetStringValue(string name)

Parameters
name(string)

The name of the attribute.

GetValue(string)
Gets an attribute value by its name.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
AttributeCollection

Declaration Syntax
public virtual object GetValue(string name)

Parameters
name(string)

The name of the attribute.

GetValue(string, object)
Gets an attribute value by its name.

Declaration Syntax
public virtual object GetValue(string name, object defaultValue)

Parameters
name(string)

The name of the attribute.

defaultValue(object)

The default value

Remove(string)
Remove an attribute. The attribute cannot be removed if it was declared as static attribute.

Declaration Syntax
public virtual bool Remove(string name)

Parameters
name(string)

The name of the attribute.

SetValue(string, object)
Set an attribute value.

Declaration Syntax
public virtual void SetValue(string name, object value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
Ansys.ACT.Core.Utilities Namespace

Parameters
name(string)

The name of the attribute.

value(object)

The value of the attrbiute.

NamedCollection<T>
Represents a collection of INamed objects that could be found by its Name field.

Declaration Syntax
public class NamedCollection<T> : ReadOnlyCollection<T>, INamedCollection<T>

Table 8: Members

Property Item (p. 10) The operator [] can find an object by its name.
Property Names (p. 10) Returns the list of the names of the objects in the
collection.

Item(string)
The operator [] can find an object by its name.

Declaration Syntax
public T Item { get; }

Names
Returns the list of the names of the objects in the collection.

Declaration Syntax
public ReadOnlyCollection<string> Names { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Selection Namespace
Declaration Syntax
namespace Ansys.Mechanical.Selection

Table 9: Members

GeometryRayCastHit (p. 11) GeometryRayCastHit, contains geoEntity and vector


normal
GeometryRayCastSettings (p. 12) No details are provided for this entry.
SelectionHelper (p. 13) No details are provided for this entry.

GeometryRayCastHit
GeometryRayCastHit, contains geoEntity and vector normal

Declaration Syntax
public class GeometryRayCastHit

Table 10: Members

Property Entity (p. 11) Geometry entity hit by ray cast


Property HitVector (p. 11) BoundVector with location and normal direction on geometry entity to
ray cast

Entity
Geometry entity hit by ray cast

Declaration Syntax
public IGeoEntity Entity { set;get; }

HitVector
BoundVector with location and normal direction on geometry entity to ray cast

Declaration Syntax
public BoundVector HitVector { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
Ansys.Mechanical.Selection Namespace

GeometryRayCastSettings
No details are provided for this entry.

Declaration Syntax
public class GeometryRayCastSettings

Table 11: Members

Constructor GeometryRayCastSettings() (p. 12) Creates a new GeometryRayCastSettings instance.


Property CastLength (p. 12) Optional; specifies maximum axial distance from
BoundVector origin. Defaults to maximum needed
length.
Property CastRadius (p. 12) Optional; specifies maximum radial distance from
BoundVector.
Property HitBodies (p. 13) Specifies whether ray casting should hit bodies.
Defaults to false.
Property HitEdges (p. 13) Specifies whether ray casting should hit edges.
Defaults to false.
Property HitFaces (p. 13) Specifies whether ray casting should hit faces.
Defaults to true.
Property HitVertices (p. 13) Specifies whether ray casting should hit vertices.
Defaults to false.
Property MaxHits (p. 13) Specifies maximum number of ray casting hits.
Defaults to 1000.

GeometryRayCastSettings()
Creates a new GeometryRayCastSettings instance.

Declaration Syntax
public GeometryRayCastSettings()

CastLength
Optional; specifies maximum axial distance from BoundVector origin. Defaults to maximum needed
length.

Declaration Syntax
public Quantity CastLength { set;get; }

CastRadius
Optional; specifies maximum radial distance from BoundVector.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionHelper

Declaration Syntax
public Quantity CastRadius { set;get; }

HitBodies
Specifies whether ray casting should hit bodies. Defaults to false.

Declaration Syntax
public bool HitBodies { set;get; }

HitEdges
Specifies whether ray casting should hit edges. Defaults to false.

Declaration Syntax
public bool HitEdges { set;get; }

HitFaces
Specifies whether ray casting should hit faces. Defaults to true.

Declaration Syntax
public bool HitFaces { set;get; }

HitVertices
Specifies whether ray casting should hit vertices. Defaults to false.

Declaration Syntax
public bool HitVertices { set;get; }

MaxHits
Specifies maximum number of ray casting hits. Defaults to 1000.

Declaration Syntax
public uint MaxHits { set;get; }

SelectionHelper
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
Ansys.Mechanical.Selection Namespace

Declaration Syntax
public class SelectionHelper

Table 12: Members

Method CastRayOnGeometry(BoundVector, Finds geometry entities intersecting input BoundVector


GeometryRayCastSettings) (p. 14) and returns them in list of GeometryRayCastHit. These
are returned in the order they are hit, each item
containing the entity and BoundVector normal to point
hit.
Method CreateVector3D(ISelectionInfo, Creates a Vector3D object based on the given selection
bool) (p. 14) and reverse flag. The direction is computed as the
outward normal of a planar face, the direction between
two nodes or vertices from the first to the second, or the
axis of an edge. The reversed flag will return the opposite
of the computed direction.

CastRayOnGeometry(BoundVector, GeometryRayCastSettings)
Finds geometry entities intersecting input BoundVector and returns them in list of GeometryRayCastHit.
These are returned in the order they are hit, each item containing the entity and BoundVector normal
to point hit.

Declaration Syntax
public static IEnumerable<GeometryRayCastHit> CastRayOnGeometry(BoundVector castVector, Geo-
metryRayCastSettings settings)

Parameters
castVector(BoundVector)

Starting location and direction of cast ray.

settings(GeometryRayCastSettings)

Optional settings containing what geometry entity types hits will return.

CreateVector3D(ISelectionInfo, bool)
Creates a Vector3D object based on the given selection and reverse flag. The direction is computed
as the outward normal of a planar face, the direction between two nodes or vertices from the first
to the second, or the axis of an edge. The reversed flag will return the opposite of the computed
direction.

Declaration Syntax
public static Vector3D CreateVector3D(ISelectionInfo selection, bool reversed)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionHelper

Parameters
selection(ISelectionInfo)

No details are provided for this entry.

reversed(bool)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Math Namespace
Declaration Syntax
namespace Ansys.Mechanical.Math

Table 13: Members

BoundVector (p. 17) A vector with fixed intial point and terminal point. Or a vector with fixed initial
point(origin) and a direction(vector).

BoundVector
A vector with fixed intial point and terminal point. Or a vector with fixed initial point(origin) and a dir-
ection(vector).

Declaration Syntax
public class BoundVector

Table 14: Members

Constructor BoundVector(Point, Vector3D) (p. 17) Creates a BoundVector from a point and a
vector.
Property Origin (p. 18) The location at the start of the BoundVector.
Property Vector (p. 18) The direction of the BoundVector.

BoundVector(Point, Vector3D)
Creates a BoundVector from a point and a vector.

Declaration Syntax
public BoundVector(Point point, Vector3D vector)

Parameters
point(Point)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
Ansys.Mechanical.Math Namespace

vector(Vector3D)

No details are provided for this entry.

Origin
The location at the start of the BoundVector.

Declaration Syntax
public Point Origin { set;get; }

Vector
The direction of the BoundVector.

Declaration Syntax
public Vector3D Vector { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.UI.Enums Namespace
Declaration Syntax
namespace Ansys.Mechanical.UI.Enums

Table 15: Members

ThemeName (p. 19) Represents the different themes that can be set in
Mechanical.

ThemeName
Represents the different themes that can be set in Mechanical.

Declaration Syntax
public enum ThemeName

Table 16: Members

Member Classic Classic


theme.
Member Dark Dark
theme.
Member Light Light
theme.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.UI.Interfaces Namespace
Declaration Syntax
namespace Ansys.Mechanical.UI.Interfaces

Table 17: Members

IMechanicalTheme (p. 21) No details are provided for this


entry.
IMechanicalUserInterface (p. 22) No details are provided for this
entry.

IMechanicalTheme
No details are provided for this entry.

Declaration Syntax
public interface IMechanicalTheme

Table 18: Members

Property ColorPalette (p. 21) Palette object, which provides an entry point to get Mechnical
UI's theme colors represented as Ansys.Utilities.Color objects
Property HexadecimalPalette (p. 22) Palette object, which provides an entry point to get Mechnical
UI's theme colors represented in Hexadecimal. ei. #FFFFFF
Property IntPalette (p. 22) Palette object, which provides an entry point to get Mechnical
UI's theme colors represented as integers formatted as BGR
Property Name (p. 22) The name of the theme as an enum value.

ColorPalette
Palette object, which provides an entry point to get Mechnical UI's theme colors represented as An-
sys.Utilities.Color objects

Declaration Syntax
public Palette ColorPalette { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
Ansys.Mechanical.UI.Interfaces Namespace

HexadecimalPalette
Palette object, which provides an entry point to get Mechnical UI's theme colors represented in
Hexadecimal. ei. #FFFFFF

Declaration Syntax
public Palette HexadecimalPalette { get; }

IntPalette
Palette object, which provides an entry point to get Mechnical UI's theme colors represented as integers
formatted as BGR

Declaration Syntax
public Palette IntPalette { get; }

Name
The name of the theme as an enum value.

Declaration Syntax
public ThemeName Name { get; }

IMechanicalUserInterface
No details are provided for this entry.

Declaration Syntax
public interface IMechanicalUserInterface

Table 19: Members

Property Theme (p. 22) Information about the current theme being in
Mechanical.

Theme
Information about the current theme being in Mechanical.

Declaration Syntax
public IMechanicalTheme Theme { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Table Namespace
Declaration Syntax
namespace Ansys.Mechanical.Table

Table 20: Members

ColumnarDataImportDefinition (p. 23) A simple class to hold the import definitions for how a
column from a data source in columnar format should be
processed.
DelimitedImportSettings (p. 25) (See Ansys.Mechanical.Table.DelimitedImportSettings) defines
how to import data from a delimited source for tabular data.
FixedWidthImportSettings (p. 26) (See Ansys.Mechanical.Table.FixedWidthImportSettings)
defines how to import data from a delimited source for
tabular data.
ImportHelpers (p. 27) No details are provided for this entry.
ImportSettingsBase (p. 27) A base class for Table import settings.
ImportSettingsFactory (p. 28) No details are provided for this entry.

ColumnarDataImportDefinition
A simple class to hold the import definitions for how a column from a data source in columnar format
should be processed.

Declaration Syntax
public class ColumnarDataImportDefinition

Table 21: Members

Constructor ColumnarDataImportDefinition(int, Construct a (See


VariableType, VariableClassification, Ansys.Mechanical.Table.ColumnarDataImportDefinition)
string, string) (p. 24) instance.
Property Index (p. 24) Gets or sets the specified data source column
index from which this variable will be imported.
Property Name (p. 24) Gets or sets an identifier for the data source
column.
Property Unit (p. 25) Gets or sets the unit of the column.
Property VariableClassification (p. 25) Gets or sets the variable classification of the
column.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
Ansys.Mechanical.Table Namespace

Property VariableType (p. 25) Gets or sets the variable type of the column.

ColumnarDataImportDefinition(int, VariableType, VariableClassification,


string, string)
Construct a (See Ansys.Mechanical.Table.ColumnarDataImportDefinition) instance.

Declaration Syntax
public ColumnarDataImportDefinition(int index, VariableType variableType, VariableClassification
variableClassification, string unit, string name)

Parameters
index(int)

The specified data source column index to be imported.

variableType(VariableType)

The specified variable type of the data source column.

variableClassification(VariableClassification)

Gets or sets the variable classification of the column.

unit(string)

The specified unit for the data source column (optional).

name(string)

The specified name for the data source column (optional).

Index
Gets or sets the specified data source column index from which this variable will be imported.

Declaration Syntax
public int Index { set;get; }

Name
Gets or sets an identifier for the data source column.

Declaration Syntax
public string Name { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
DelimitedImportSettings

Unit
Gets or sets the unit of the column.

Declaration Syntax
public string Unit { set;get; }

VariableClassification
Gets or sets the variable classification of the column.

Declaration Syntax
public VariableClassification VariableClassification { set;get; }

VariableType
Gets or sets the variable type of the column.

Declaration Syntax
public VariableType VariableType { set;get; }

DelimitedImportSettings
(See Ansys.Mechanical.Table.DelimitedImportSettings) defines how to import data from a delimited
source for tabular data.

Declaration Syntax
public class DelimitedImportSettings : ColumnarDataSourceBase

Table 22: Members

Property Delimiter (p. 25) The delimiter used to separate columns.


Property Format (p. 27) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 27).)


Property PathType (p. 27) Gets or sets the type of URI provided for Table import. Default: (See
Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType.Absolute)

(Inherited from ImportSettingsBase (p. 27).)

Delimiter
The delimiter used to separate columns.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
Ansys.Mechanical.Table Namespace

Declaration Syntax
public string Delimiter { set;get; }

FixedWidthImportSettings
(See Ansys.Mechanical.Table.FixedWidthImportSettings) defines how to import data from a delimited
source for tabular data.

Declaration Syntax
public class FixedWidthImportSettings : ColumnarDataSourceBase

Table 23: Members

Property ColumnWidths (p. 26) Gets or sets the specified column widths. When setting, The value
provided to (See
Ansys.Mechanical.Table.FixedWidthImportSettings.ColumnWidths) may
be either:

A `string` using Fortran-esque fixed-format specifications. This


is similar to the “User-Defined” format specifier for External
Data as described in the product documentation. Note,
however, that regardless of the format specifier all imported
columns WILL be interpreted using the .NET command
`double.TryParse()` to support the requirements of the
underlying variable data for Table.
An containing the widths of each column. Negative values
may be specified to define a negated width, meaning ‘-2’
would be equivalent to the fixed-width string specification
’2X’.
Property Format (p. 27) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 27).)


Property PathType (p. 27) Gets or sets the type of URI provided for Table import. Default: (See
Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType.Absolute)

(Inherited from ImportSettingsBase (p. 27).)

ColumnWidths
Gets or sets the specified column widths. When setting, The value provided to (See Ansys.Mechanic-
al.Table.FixedWidthImportSettings.ColumnWidths) may be either:

A `string` using Fortran-esque fixed-format specifications. This is similar to the “User-Defined”


format specifier for External Data as described in the product documentation. Note, however,
that regardless of the format specifier all imported columns WILL be interpreted using the
.NET command `double.TryParse()` to support the requirements of the underlying variable
data for Table.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportSettingsBase

An containing the widths of each column. Negative values may be specified to define a
negated width, meaning ‘-2’ would be equivalent to the fixed-width string specification ’2X’.

Declaration Syntax
public object ColumnWidths { set;get; }

ImportHelpers
No details are provided for this entry.

Declaration Syntax
public class ImportHelpers

ImportSettingsBase
A base class for Table import settings.

Declaration Syntax
public class ImportSettingsBase

Table 24: Members

Property Format (p. 27) Gets the existing corresponding format.


Property PathType (p. 27) Gets or sets the type of URI provided for Table import. Default: (See
Ansys.Mechanical.DataModel.MechanicalEnums.Common.PathType.Absolute)

Format
Gets the existing corresponding format.

Declaration Syntax
public ImportFormat Format { get; }

PathType
Gets or sets the type of URI provided for Table import. Default: (See Ansys.Mechanical.DataModel.Mech-
anicalEnums.Common.PathType.Absolute)

Declaration Syntax
public PathType PathType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
Ansys.Mechanical.Table Namespace

ImportSettingsFactory
No details are provided for this entry.

Declaration Syntax
public class ImportSettingsFactory

Table 25: Members

Method GetSettingsForFormat(ImportFormat) (p. 28) (See


Ansys.Mechanical.Table.ImportSettingsFactory.GetSettingsForForm
constructs and returns the correct settings class instance based o

GetSettingsForFormat(ImportFormat)
(See Ansys.Mechanical.Table.ImportSettingsFactory.GetSettingsForFormat(Ansys.Mechanical.DataMod-
el.MechanicalEnums.Table.ImportFormat)) constructs and returns the correct settings class instance
based on the specified format.

Declaration Syntax
public static ImportSettingsBase GetSettingsForFormat(ImportFormat format)

Parameters
format(ImportFormat)

The format

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Application Namespace
Declaration Syntax
namespace Ansys.Mechanical.Application

Table 26: Members

Message (p. 29) A message.


Messages (p. 31) Defines the collection of Mechanical's
messages.
ObjectTag (p. 32) An instance of an ObjectTag.
ObjectTags (p. 34) Defines the collection of Mechanical’s tags.
Progress (p. 37) Defines a Progress.

Message
A message.

Declaration Syntax
public class Message : IEquatable<Message>

Table 27: Members

Property DisplayString (p. 29) The display string of the message.


Property Location (p. 30) The location of the message.
Property RelatedObjects (p. 30) The list of objects related to the
message.
Property Severity (p. 30) The severity of the message.
Property Source (p. 30) The source object of the message.
Property StringID (p. 30) The string ID of the message.
Property TimeStamp (p. 30) The timestamp of the message.

DisplayString
The display string of the message.

Declaration Syntax
public string DisplayString { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
Ansys.Mechanical.Application Namespace

Location
The location of the message.

Declaration Syntax
public ISelectionInfo Location { get; }

RelatedObjects
The list of objects related to the message.

Declaration Syntax
public IEnumerable<IDataModelObject> RelatedObjects { get; }

Severity
The severity of the message.

Declaration Syntax
public MessageSeverityType Severity { set;get; }

Source
The source object of the message.

Declaration Syntax
public IDataModelObject Source { set;get; }

StringID
The string ID of the message.

Declaration Syntax
public string StringID { set;get; }

TimeStamp
The timestamp of the message.

Declaration Syntax
public DateTime TimeStamp { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
Messages

Messages
Defines the collection of Mechanical's messages.

Declaration Syntax
public class Messages : ICollection<Message>, IEnumerable<Message>, IEnumerable, IReadOnlyList<Mes-
sage>, IReadOnlyCollection<Message>

Table 28: Members

Property Count (p. 31) Get the number of messages.


Method Add(Message) (p. 31) Add a new message.
Method Clear() (p. 31) Clear the list of the messages.
Method Contains(Message) (p. 32) Check if a message is in the current list of
messages.
Method Remove(Message) (p. 32) Remove a specific message in the list.
Method ShowErrors() (p. 32) Shows errors with current project.

Count
Get the number of messages.

Declaration Syntax
public int Count { get; }

Add(Message)
Add a new message.

Declaration Syntax
public virtual void Add(Message item)

Parameters
item(Message)

The message to be added.

Clear()
Clear the list of the messages.

Declaration Syntax
public virtual void Clear()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
Ansys.Mechanical.Application Namespace

Contains(Message)
Check if a message is in the current list of messages.

Declaration Syntax
public virtual bool Contains(Message item)

Parameters
item(Message)

The message to be searched for.

Remove(Message)
Remove a specific message in the list.

Declaration Syntax
public virtual bool Remove(Message item)

Parameters
item(Message)

The message to be removed.

ShowErrors()
Shows errors with current project.

Declaration Syntax
public virtual void ShowErrors()

ObjectTag
An instance of an ObjectTag.

Declaration Syntax
public class ObjectTag : IObjectTag

Table 29: Members

Constructor ObjectTag(string) (p. 33) Creates a new tag with the given name

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectTag

Property Name (p. 33) The name of the tag. If the tag exists in
ObjectTags, attempting to set the name to a
value of another tag in that collection will lead
to an exception.
Property Objects (p. 33) The list of objects which use this tag.
Method AddObject(IDataModelObject) (p. 33) Add an object to this tag.
Method ClearObjects() (p. 34) Clear all objects from this tag.
Method RemoveObject(IDataModelObject) (p. 34) Remove an object from this tag.

ObjectTag(string)
Creates a new tag with the given name

Declaration Syntax
public ObjectTag(string name)

Parameters
name(string)

No details are provided for this entry.

Name
The name of the tag. If the tag exists in ObjectTags, attempting to set the name to a value of another
tag in that collection will lead to an exception.

Declaration Syntax
public string Name { set;get; }

Objects
The list of objects which use this tag.

Declaration Syntax
public IEnumerable<IDataModelObject> Objects { get; }

AddObject(IDataModelObject)
Add an object to this tag.

Declaration Syntax
public virtual void AddObject(IDataModelObject obj)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
Ansys.Mechanical.Application Namespace

Parameters
obj(IDataModelObject)

No details are provided for this entry.

ClearObjects()
Clear all objects from this tag.

Declaration Syntax
public virtual void ClearObjects()

RemoveObject(IDataModelObject)
Remove an object from this tag.

Declaration Syntax
public virtual void RemoveObject(IDataModelObject obj)

Parameters
obj(IDataModelObject)

No details are provided for this entry.

ObjectTags
Defines the collection of Mechanical’s tags.

Declaration Syntax
public class ObjectTags : IReadOnlyList<ObjectTag>, IReadOnlyCollection<ObjectTag>, IEnumerable<Ob-
jectTag>, IEnumerable, ICollection<ObjectTag>

Table 30: Members

Property Count (p. 35) The number of tags in the collection.


Property Item (p. 35) Retrieves the tag in the collection at the given index.
Property Item (p. 35) Retrieves the tag in the collection with the given name
Property TagNames (p. 35) The names of the tags in the collection.
Method Add(ObjectTag) (p. 35) Adds a new tag to the collection. Throws an error if the tag
already exists in the collection.
Method Clear() (p. 36) Clears the collection, removing all objects from the tags in
the collection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectTags

Method Contains(ObjectTag) (p. 36) Returns whether or not the collection contains the given tag.
Method GetTag(string) (p. 36) Returns the tag in the collection with the given name.
Method IndexOf(ObjectTag) (p. 36) Returns the index of the given tag. If the given tag does not
exist in the collection, returns -1.
Method Remove(ObjectTag) (p. 37) Removes a tag if it exists in the collection.
Method RemoveAt(int) (p. 37) Removes the tag at the given index from the collection.

Count
The number of tags in the collection.

Declaration Syntax
public int Count { get; }

Item(int)
Retrieves the tag in the collection at the given index.

Declaration Syntax
public ObjectTag Item { get; }

Item(string)
Retrieves the tag in the collection with the given name

Declaration Syntax
public ObjectTag Item { get; }

TagNames
The names of the tags in the collection.

Declaration Syntax
public List<string> TagNames { get; }

Add(ObjectTag)
Adds a new tag to the collection. Throws an error if the tag already exists in the collection.

Declaration Syntax
public virtual void Add(ObjectTag tag)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
Ansys.Mechanical.Application Namespace

Parameters
tag(ObjectTag)

The ObjectTag to add

Clear()
Clears the collection, removing all objects from the tags in the collection.

Declaration Syntax
public virtual void Clear()

Contains(ObjectTag)
Returns whether or not the collection contains the given tag.

Declaration Syntax
public virtual bool Contains(ObjectTag tag)

Parameters
tag(ObjectTag)

The ObjectTag to check

GetTag(string)
Returns the tag in the collection with the given name.

Declaration Syntax
public ObjectTag GetTag(string tagName)

Parameters
tagName(string)

The name of the tag to find and return

IndexOf(ObjectTag)
Returns the index of the given tag. If the given tag does not exist in the collection, returns -1.

Declaration Syntax
public int IndexOf(ObjectTag tag)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
Progress

Parameters
tag(ObjectTag)

The item to get the index of.

Remove(ObjectTag)
Removes a tag if it exists in the collection.

Declaration Syntax
public virtual bool Remove(ObjectTag tag)

Parameters
tag(ObjectTag)

The ObjectTag to remove

RemoveAt(int)
Removes the tag at the given index from the collection.

Declaration Syntax
public void RemoveAt(int index)

Parameters
index(int)

The index of the tag to remove

Progress
Defines a Progress.

Declaration Syntax
public class Progress

Table 31: Members

Method SetProgress(uint, string, uint, string) (p. 38) Set the current
progress state

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
Ansys.Mechanical.Application Namespace

SetProgress(uint, string, uint, string)


Set the current progress state

Declaration Syntax
public void SetProgress(uint uiProgress, string uiMessage, uint uiSubProgress, string uiSubMessage)

Parameters
uiProgress(uint)

Main progress bar (values 0 to 100)

uiMessage(string)

Main progress message

uiSubProgress(uint)

Sub progress bar (values 0 to 100)

uiSubMessage(string)

Sub progress message

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Materials Namespace
Declaration Syntax
namespace Ansys.Mechanical.Materials

Table 32: Members

ImportSettings (p. 39) No details are provided for this


entry.

ImportSettings
No details are provided for this entry.

Declaration Syntax
public class ImportSettings

Table 33: Members

Field Operation (p. 39) A enum to specify what should occur when a material being
imported has the same identifiers as a material which already
exists in Mechanical.
Field PrimaryIdentifierType (p. 39) The primary identifier to use when searching for duplicate
materials
Property Filter (p. 40) All materials will be imported if this list of the names of
specific materials to be imported is not specified.

Operation
A enum to specify what should occur when a material being imported has the same identifiers as a
material which already exists in Mechanical.

Declaration Syntax
public ExistingMaterialOperation Operation

PrimaryIdentifierType
The primary identifier to use when searching for duplicate materials

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
Ansys.Mechanical.Materials Namespace

Declaration Syntax
public IdentifierType PrimaryIdentifierType

Filter
All materials will be imported if this list of the names of specific materials to be imported is not spe-
cified.

Declaration Syntax
public IList<string> Filter { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.ExternalData Namespace
Declaration Syntax
namespace Ansys.Mechanical.ExternalData

Table 34: Members

AXDTImportSettings (p. 41) (See Ansys.Mechanical.ExternalData.AXDTImportSettings)


defines how to import external data from an AXDT file.
ColumnarDataImportDefinition (p. 42) A simple class to hold the import definitions for how a column
from a data source in columnar format should be processed.
ColumnarDataSourceBase (p. 44) (See Ansys.Mechanical.ExternalData.ColumnarDataSourceBase)
is a class that provides foundational behavior for import
settings that consume data from columnar data sources (such
as delimited or fixed-width files).
DelimitedImportSettings (p. 47) (See Ansys.Mechanical.ExternalData.DelimitedImportSettings)
defines how to import external data from a delimited source
file.
ECADImportSettings (p. 48) (See Ansys.Mechanical.ExternalData.ECADImportSettings)
defines how to import external data from an ECAD file.
ExternalDataFile (p. 49) A basic definition of the external data file.
ExternalDataFileCollection (p. 51) (See Ansys.Mechanical.ExternalData.ExternalDataFileCollection)
is a class that provides foundational behavior for holding
external data files.
FixedWidthImportSettings (p. 56) (See Ansys.Mechanical.ExternalData.FixedWidthImportSettings)
defines how to import external data from a fixed-width source
file.
ICEPAKImportSettings (p. 58) (See Ansys.Mechanical.ExternalData.ICEPAKImportSettings)
defines how to import external data from an ICEPAK BOOL
or ICEPAK COND file.
ImportSettingsBase (p. 59) A base class for Table import settings.
ImportSettingsFactory (p. 59) No details are provided for this entry.
MAPDLImportSettings (p. 60) (See Ansys.Mechanical.ExternalData.MAPDLImportSettings)
defines how to import external data from a MAPDL CDB file.

AXDTImportSettings
(See Ansys.Mechanical.ExternalData.AXDTImportSettings) defines how to import external data from an
AXDT file.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
Ansys.Mechanical.ExternalData Namespace

Declaration Syntax
public class AXDTImportSettings : ImportSettingsBase

Table 35: Members

Property Dimension (p. 42) The dimension of the AXDT file.


Property Format (p. 59) Gets the existing corresponding
format.

(Inherited from
ImportSettingsBase (p. 59).)

Dimension
The dimension of the AXDT file.

Declaration Syntax
public SourceDimension Dimension { set;get; }

ColumnarDataImportDefinition
A simple class to hold the import definitions for how a column from a data source in columnar format
should be processed.

Declaration Syntax
public class ColumnarDataImportDefinition

Table 36: Members

Constructor ColumnarDataImportDefinition(int, Construct a (See


VariableType, string, string, Ansys.Mechanical.ExternalData.ColumnarDataImportDefinition)
string) (p. 42) instance.
Property Index (p. 43) Gets or sets the specified data source column index from
which this variable will be imported.
Property Name (p. 43) Gets or sets an identifier for the data source column.
Property Unit (p. 43) Gets or sets the unit of the column.
Property UserFieldVariable (p. 44) Gets or sets the user field variable type as a string for
the column.

This property is only used when VariableType is UserField.


Property VariableType (p. 44) Gets or sets the variable type of the column.

ColumnarDataImportDefinition(int, VariableType, string, string, string)


Construct a (See Ansys.Mechanical.ExternalData.ColumnarDataImportDefinition) instance.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
ColumnarDataImportDefinition

Declaration Syntax
public ColumnarDataImportDefinition(int index, VariableType variableType, string unit, string name,
string userFieldVariable)

Parameters
index(int)

The specified data source column index to be imported (optional).

variableType(VariableType)

The specified variable type of the data source column (optional).

unit(string)

The specified unit for the data source column (optional).

name(string)

The specified name for the data source column (optional).

userFieldVariable(string)

The specified user field variable type as a string for the data source column (optional).

Index
Gets or sets the specified data source column index from which this variable will be imported.

Declaration Syntax
public int Index { set;get; }

Name
Gets or sets an identifier for the data source column.

Declaration Syntax
public string Name { set;get; }

Unit
Gets or sets the unit of the column.

Declaration Syntax
public string Unit { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
Ansys.Mechanical.ExternalData Namespace

UserFieldVariable
Gets or sets the user field variable type as a string for the column.

This property is only used when VariableType is UserField.

Declaration Syntax
public string UserFieldVariable { set;get; }

VariableType
Gets or sets the variable type of the column.

Declaration Syntax
public VariableType VariableType { set;get; }

ColumnarDataSourceBase
(See Ansys.Mechanical.ExternalData.ColumnarDataSourceBase) is a class that provides foundational be-
havior for import settings that consume data from columnar data sources (such as delimited or fixed-
width files).

Declaration Syntax
public class ColumnarDataSourceBase : ImportSettingsBase, IEnumerable<ColumnarDataImportDefinition>,
IEnumerable

Table 37: Members

Property Count (p. 45) Gets the number of column definitions.


Property Format (p. 59) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 59).)


Property Item (p. 45) Gets or sets the column definition at the specified order index.
Property SkipFooter (p. 45) Gets or sets the number of rows to ignore at the end of the
file during import.
Property SkipRows (p. 45) Gets or sets the number of rows to skip over at the start of
the file during import.
Method Clear() (p. 45) No details are provided for this entry.
Method GetEnumerator() (p. 46) No details are provided for this entry.
Method RemoveAt(int) (p. 46) Removes the import definition at the specified index.
Method UseColumn(int, Add a column to be imported from the specified data source
VariableType, string, column index and configured as the specified variable type.
string) (p. 46) The order in which columns are added determines their order
in the table/>.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
ColumnarDataSourceBase

If unit is `null`, the default unit (in the active unit system) for
the specified variable type will be assumed during import.

If name is `null` or empty, a unique name will be generated


from the specified variableType during import.

A reference to the instance is returned so that invocations


can be chained together.

Count
Gets the number of column definitions.

Declaration Syntax
public int Count { get; }

Item(int)
Gets or sets the column definition at the specified order index.

Declaration Syntax
public ColumnarDataImportDefinition Item { set;get; }

SkipFooter
Gets or sets the number of rows to ignore at the end of the file during import.

Declaration Syntax
public int SkipFooter { set;get; }

SkipRows
Gets or sets the number of rows to skip over at the start of the file during import.

Declaration Syntax
public int SkipRows { set;get; }

Clear()
No details are provided for this entry.

Declaration Syntax
public void Clear()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
Ansys.Mechanical.ExternalData Namespace

GetEnumerator()
No details are provided for this entry.

Declaration Syntax
public virtual IEnumerator<ColumnarDataImportDefinition> GetEnumerator()

RemoveAt(int)
Removes the import definition at the specified index.

Declaration Syntax
public void RemoveAt(int index)

Parameters
index(int)

The specified definition index.

UseColumn(int, VariableType, string, string)


Add a column to be imported from the specified data source column index and configured as the
specified variable type. The order in which columns are added determines their order in the table/>.

If unit is `null`, the default unit (in the active unit system) for the specified variable type will be assumed
during import.

If name is `null` or empty, a unique name will be generated from the specified variableType during
import.

A reference to the instance is returned so that invocations can be chained together.

Declaration Syntax
public ColumnarDataSourceBase UseColumn(int index, VariableType variableType, string unit, string
name)

Parameters
index(int)

The specified data source column index to be imported.

variableType(VariableType)

The specified variable type of the data source column.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
DelimitedImportSettings

unit(string)

The specified unit for the data source column (optional).

name(string)

The specified name for the data source column (optional).

DelimitedImportSettings
(See Ansys.Mechanical.ExternalData.DelimitedImportSettings) defines how to import external data from
a delimited source file.

Declaration Syntax
public class DelimitedImportSettings : ColumnarDataSourceBase

Table 38: Members

Property AverageCornerNodesToMidsideNodes (p. 48) If set to Yes, the data at Midside nodes is
calculated as average of data specified at
corner nodes.

Defaults to False.

This property is used only when there is


another external data file defined with
MAPDL import format.
Property Count (p. 45) Gets the number of column definitions.

(Inherited from
ColumnarDataSourceBase (p. 44).)
Property Delimiter (p. 48) The delimiter used to separate columns.
Property Format (p. 59) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 59).)


Property Item (p. 45) Gets or sets the column definition at the
specified order index.

(Inherited from
ColumnarDataSourceBase (p. 44).)
Property SkipFooter (p. 45) Gets or sets the number of rows to ignore at
the end of the file during import.

(Inherited from
ColumnarDataSourceBase (p. 44).)
Property SkipRows (p. 45) Gets or sets the number of rows to skip over
at the start of the file during import.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
Ansys.Mechanical.ExternalData Namespace

(Inherited from
ColumnarDataSourceBase (p. 44).)

AverageCornerNodesToMidsideNodes
If set to Yes, the data at Midside nodes is calculated as average of data specified at corner nodes.

Defaults to False.

This property is used only when there is another external data file defined with MAPDL import format.

Declaration Syntax
public bool AverageCornerNodesToMidsideNodes { set;get; }

Delimiter
The delimiter used to separate columns.

Declaration Syntax
public string Delimiter { set;get; }

ECADImportSettings
(See Ansys.Mechanical.ExternalData.ECADImportSettings) defines how to import external data from an
ECAD file.

Declaration Syntax
public class ECADImportSettings : ImportSettingsBase

Table 39: Members

Property Format (p. 59) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 59).)


Property UseDummyNetData (p. 48) The UseDummyNetData falg of the ECAD file. For External Data
files that include trace mapping, selecting this option enables
you to import trace data belonging to the dummy net of the
file.

UseDummyNetData
The UseDummyNetData falg of the ECAD file. For External Data files that include trace mapping, se-
lecting this option enables you to import trace data belonging to the dummy net of the file.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalDataFile

Declaration Syntax
public bool UseDummyNetData { set;get; }

ExternalDataFile
A basic definition of the external data file.

Declaration Syntax
public class ExternalDataFile

Table 40: Members

Constructor ExternalDataFile(ImportSettingsBase, Construct a (See


string, string, string, bool, Ansys.Mechanical.ExternalData.ExternalDataFile)
bool) (p. 50) instance.

If `identifier` is provided, it should be unique,


otherwise, an exception will be thrown during the
import.

An import settings can be created by calling the


GetSettingsForFormat method from the factory
class (See
Ansys.Mechanical.ExternalData.ImportSettingsFactory).
Property Description (p. 50) Gets or sets the optional description of the external
data file.
Property FilePath (p. 51) Gets or sets the file path of the external data file.
Property Identifier (p. 51) Gets or sets the identifier of the external data file.
Property ImportSettings (p. 51) Gets or sets the import settings for current external
data file.

An import settings can be created by calling the


GetSettingsForFormat method from the factory
class (See
Ansys.Mechanical.ExternalData.ImportSettingsFactory).
Property IsMainFile (p. 51) Gets or sets the main file flag of the external data
file.

The nodal coordinate data for the selected main


file is processed by the mapping utility. The nodal
coordinate data will be skipped in all other files.

Only one file can be set as the main file, otherwise,


an exception will be thrown during the import.

If the import format is MAPDL, the value of this


property will be ignored as the MAPDL CDB file

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
Ansys.Mechanical.ExternalData Namespace

will always be treated as main file during the


import.

ExternalDataFile(ImportSettingsBase, string, string, string, bool, bool)


Construct a (See Ansys.Mechanical.ExternalData.ExternalDataFile) instance.

If `identifier` is provided, it should be unique, otherwise, an exception will be thrown during the import.

An import settings can be created by calling the GetSettingsForFormat method from the factory class
(See Ansys.Mechanical.ExternalData.ImportSettingsFactory).

Declaration Syntax
public ExternalDataFile(ImportSettingsBase importSettings, string filePath, string identifier, string de-
scription, bool isMainFile, bool isRootRelativePath)

Parameters
importSettings(ImportSettingsBase)

The specified import Settings for this external data file (optional).

filePath(string)

The specified file path for this external data file (optional).

identifier(string)

The specified unique identifier for this external data file (optional).

description(string)

The specified description for this external data file (optional).

isMainFile(bool)

The main file flag for this external data file (optional).

isRootRelativePath(bool)

Bool to identify if it is a root relative file (optional).

Description
Gets or sets the optional description of the external data file.

Declaration Syntax
public string Description { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalDataFileCollection

FilePath
Gets or sets the file path of the external data file.

Declaration Syntax
public string FilePath { set;get; }

Identifier
Gets or sets the identifier of the external data file.

Declaration Syntax
public string Identifier { set;get; }

ImportSettings
Gets or sets the import settings for current external data file.

An import settings can be created by calling the GetSettingsForFormat method from the factory class
(See Ansys.Mechanical.ExternalData.ImportSettingsFactory).

Declaration Syntax
public ImportSettingsBase ImportSettings { set;get; }

IsMainFile
Gets or sets the main file flag of the external data file.

The nodal coordinate data for the selected main file is processed by the mapping utility. The nodal
coordinate data will be skipped in all other files.

Only one file can be set as the main file, otherwise, an exception will be thrown during the import.

If the import format is MAPDL, the value of this property will be ignored as the MAPDL CDB file will
always be treated as main file during the import.

Declaration Syntax
public bool IsMainFile { set;get; }

ExternalDataFileCollection
(See Ansys.Mechanical.ExternalData.ExternalDataFileCollection) is a class that provides foundational
behavior for holding external data files.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
Ansys.Mechanical.ExternalData Namespace

Declaration Syntax
public class ExternalDataFileCollection : IList<ExternalDataFile>, ICollection<ExternalDataFile>, IEnumer-
able<ExternalDataFile>, IEnumerable

Table 41: Members

Constructor ExternalDataFileCollection(bool) (p. 52) Construct a (See


Ansys.Mechanical.ExternalData.ExternalDataFileCollection)
instance.
Property Count (p. 52) Gets the number of external data files.
Property Item (p. 53) Gets or sets the external data file at the specified
order index.
Property SaveFilesWithProject (p. 53) Gets or sets the flag controlling if the external data
files will be copied to the project directory. If this
flag is set to False, the external data files will directly
reference the file path. The default is False.
Method Add(ExternalDataFile) (p. 53) No details are provided for this entry.
Method Clear() (p. 53) No details are provided for this entry.
Method Contains(ExternalDataFile) (p. 53) No details are provided for this entry.
Method CopyTo(ExternalDataFile[], int) (p. 54) No details are provided for this entry.
Method GetEnumerator() (p. 54) No details are provided for this entry.
Method IndexOf(ExternalDataFile) (p. 54) No details are provided for this entry.
Method Insert(int, ExternalDataFile) (p. 55) No details are provided for this entry.
Method Remove(ExternalDataFile) (p. 55) No details are provided for this entry.
Method RemoveAt(int) (p. 55) No details are provided for this entry.

ExternalDataFileCollection(bool)
Construct a (See Ansys.Mechanical.ExternalData.ExternalDataFileCollection) instance.

Declaration Syntax
public ExternalDataFileCollection(bool saveFilesWithProject)

Parameters
saveFilesWithProject(bool)

The flag controlling if the external data files will be copied to the project directory. If this flag is
set to False, the external data files will directly reference the file path. The default is False. (optional).

Count
Gets the number of external data files.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalDataFileCollection

Declaration Syntax
public int Count { get; }

Item(int)
Gets or sets the external data file at the specified order index.

Declaration Syntax
public ExternalDataFile Item { set;get; }

SaveFilesWithProject
Gets or sets the flag controlling if the external data files will be copied to the project directory. If this
flag is set to False, the external data files will directly reference the file path. The default is False.

Declaration Syntax
public bool SaveFilesWithProject { set;get; }

Add(ExternalDataFile)
No details are provided for this entry.

Declaration Syntax
public virtual void Add(ExternalDataFile item)

Parameters
item(ExternalDataFile)

No details are provided for this entry.

Clear()
No details are provided for this entry.

Declaration Syntax
public virtual void Clear()

Contains(ExternalDataFile)
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
Ansys.Mechanical.ExternalData Namespace

Declaration Syntax
public virtual bool Contains(ExternalDataFile item)

Parameters
item(ExternalDataFile)

No details are provided for this entry.

CopyTo(ExternalDataFile[], int)
No details are provided for this entry.

Declaration Syntax
public virtual void CopyTo(ExternalDataFile[] array, int arrayIndex)

Parameters
array(ExternalDataFile[])

No details are provided for this entry.

arrayIndex(int)

No details are provided for this entry.

GetEnumerator()
No details are provided for this entry.

Declaration Syntax
public virtual IEnumerator<ExternalDataFile> GetEnumerator()

IndexOf(ExternalDataFile)
No details are provided for this entry.

Declaration Syntax
public virtual int IndexOf(ExternalDataFile item)

Parameters
item(ExternalDataFile)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalDataFileCollection

Insert(int, ExternalDataFile)
No details are provided for this entry.

Declaration Syntax
public virtual void Insert(int index, ExternalDataFile item)

Parameters
index(int)

No details are provided for this entry.

item(ExternalDataFile)

No details are provided for this entry.

Remove(ExternalDataFile)
No details are provided for this entry.

Declaration Syntax
public virtual bool Remove(ExternalDataFile item)

Parameters
item(ExternalDataFile)

No details are provided for this entry.

RemoveAt(int)
No details are provided for this entry.

Declaration Syntax
public virtual void RemoveAt(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
Ansys.Mechanical.ExternalData Namespace

FixedWidthImportSettings
(See Ansys.Mechanical.ExternalData.FixedWidthImportSettings) defines how to import external data
from a fixed-width source file.

Declaration Syntax
public class FixedWidthImportSettings : ColumnarDataSourceBase

Table 42: Members

Property AverageCornerNodesToMidsideNodes (p. 57) If set to Yes, the data at Midside nodes is
calculated as average of data specified at
corner nodes.

Defaults to False.

This property is used only when there is


another external data file defined with
MAPDL import format.
Property ColumnWidths (p. 57) Gets or sets the specified column widths as
a `string` using Fortran-esque fixed-format
specifications.

This is equivalent to the “User-Defined”


format specifier for External Data as described
in the product documentation.

Note, however, that regardless of the format


specifier all imported columns WILL be
interpreted using the .NET command
`double.TryParse()` to support the
requirements of the underlying variable data
for Table.

In the example below, the line has one


integer followed by four exponential data
types. 385 8.333333333E-003
9.375000000E-003 3.375000000E-001
0.000000000E+000 The corresponding format
is `1i3,4e17.9` Where: The first entry is the
number of occurrences The second entry is
the format specifier The third entry is the
number of characters of data in the
definition(including numeric values (0-9), the
letter 'e' (for instances of scientific notation),
and any white space and + or - signs) The
fourth entry is the number of digits after the
decimal point.
Property Count (p. 45) Gets the number of column definitions.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
FixedWidthImportSettings

(Inherited from
ColumnarDataSourceBase (p. 44).)
Property Format (p. 59) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 59).)


Property Item (p. 45) Gets or sets the column definition at the
specified order index.

(Inherited from
ColumnarDataSourceBase (p. 44).)
Property SkipFooter (p. 45) Gets or sets the number of rows to ignore at
the end of the file during import.

(Inherited from
ColumnarDataSourceBase (p. 44).)
Property SkipRows (p. 45) Gets or sets the number of rows to skip over
at the start of the file during import.

(Inherited from
ColumnarDataSourceBase (p. 44).)

AverageCornerNodesToMidsideNodes
If set to Yes, the data at Midside nodes is calculated as average of data specified at corner nodes.

Defaults to False.

This property is used only when there is another external data file defined with MAPDL import format.

Declaration Syntax
public bool AverageCornerNodesToMidsideNodes { set;get; }

ColumnWidths
Gets or sets the specified column widths as a `string` using Fortran-esque fixed-format specifications.

This is equivalent to the “User-Defined” format specifier for External Data as described in the product
documentation.

Note, however, that regardless of the format specifier all imported columns WILL be interpreted using
the .NET command `double.TryParse()` to support the requirements of the underlying variable data
for Table.

In the example below, the line has one integer followed by four exponential data types. 385
8.333333333E-003 9.375000000E-003 3.375000000E-001 0.000000000E+000 The corresponding format
is `1i3,4e17.9` Where: The first entry is the number of occurrences The second entry is the format
specifier The third entry is the number of characters of data in the definition(including numeric values
(0-9), the letter 'e' (for instances of scientific notation), and any white space and + or - signs) The
fourth entry is the number of digits after the decimal point.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
Ansys.Mechanical.ExternalData Namespace

Declaration Syntax
public string ColumnWidths { set;get; }

ICEPAKImportSettings
(See Ansys.Mechanical.ExternalData.ICEPAKImportSettings) defines how to import external data from
an ICEPAK BOOL or ICEPAK COND file.

Declaration Syntax
public class ICEPAKImportSettings : ImportSettingsBase

Table 43: Members

Property Format (p. 59) Gets the existing corresponding format.

(Inherited from ImportSettingsBase (p. 59).)


Property SupportingFileDescription (p. 58) The supporting file description. This is optional.
Property SupportingFileIdentifier (p. 58) The supporting file identifier. The identifier should be
unique, otherwise, an exception will be thrown during
the import.
Property SupportingFilePath (p. 58) The supporting file path of the ICEPAK INFO file.

SupportingFileDescription
The supporting file description. This is optional.

Declaration Syntax
public string SupportingFileDescription { set;get; }

SupportingFileIdentifier
The supporting file identifier. The identifier should be unique, otherwise, an exception will be thrown
during the import.

Declaration Syntax
public string SupportingFileIdentifier { set;get; }

SupportingFilePath
The supporting file path of the ICEPAK INFO file.

Declaration Syntax
public string SupportingFilePath { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportSettingsFactory

ImportSettingsBase
A base class for Table import settings.

Declaration Syntax
public class ImportSettingsBase

Table 44: Members

Property Format (p. 59) Gets the existing corresponding


format.

Format
Gets the existing corresponding format.

Declaration Syntax
public ImportFormat Format { get; }

ImportSettingsFactory
No details are provided for this entry.

Declaration Syntax
public class ImportSettingsFactory

Table 45: Members

Method GetSettingsForFormat(ImportFormat) (p. 59) (See


Ansys.Mechanical.ExternalData.ImportSettingsFactory.GetSettings
constructs and returns the correct settings class instance based o

GetSettingsForFormat(ImportFormat)
(See Ansys.Mechanical.ExternalData.ImportSettingsFactory.GetSettingsForFormat(Ansys.Mechanic-
al.DataModel.MechanicalEnums.ExternalData.ImportFormat)) constructs and returns the correct settings
class instance based on the specified format.

Declaration Syntax
public static ImportSettingsBase GetSettingsForFormat(ImportFormat format)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
Ansys.Mechanical.ExternalData Namespace

Parameters
format(ImportFormat)

The format

MAPDLImportSettings
(See Ansys.Mechanical.ExternalData.MAPDLImportSettings) defines how to import external data from a
MAPDL CDB file.

Declaration Syntax
public class MAPDLImportSettings : ImportSettingsBase

Table 46: Members

Property Dimension (p. 60) The dimension of the MAPDL CDB


file.
Property Format (p. 59) Gets the existing corresponding
format.

(Inherited from
ImportSettingsBase (p. 59).)
Property LengthUnit (p. 60) The length unit of the MAPDL CDB
file.

Dimension
The dimension of the MAPDL CDB file.

Declaration Syntax
public SourceDimension Dimension { set;get; }

LengthUnit
The length unit of the MAPDL CDB file.

Declaration Syntax
public LengthUnit LengthUnit { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Graphics Namespace
Declaration Syntax
namespace Ansys.Mechanical.Graphics

Table 47: Members

AnalysisSettingsGraph (p. 61) No details are provided for this entry.


AnimationExportSettings (p. 62) No details are provided for this entry.
AnnotationPreferences (p. 63) No details are provided for this entry.
GlobalLegendSettings (p. 67) Defines global legend settings.
Graphics3DExportSettings (p. 68) No details are provided for this entry.
GraphicsImageExportSettings (p. 69) No details are provided for this entry.
GraphicsViewportsExportSettings (p. 71) Settings object to control Graphics.ExportViewports
behavior.
Point (p. 73) No details are provided for this entry.
ResultAnimationOptions (p. 76) No details are provided for this entry.
ResultPreference (p. 78) No details are provided for this entry.
SectionPlane (p. 80) Represents a SectionPlane object. This object holds
properties of the Plane.
SectionPlanes (p. 82) Represents the collection of section planes used by
graphics
VectorDisplay (p. 84) No details are provided for this entry.
ViewOptions (p. 86) No details are provided for this entry.

AnalysisSettingsGraph
No details are provided for this entry.

Declaration Syntax
public class AnalysisSettingsGraph

Table 48: Members

Property BoundaryConditionVisibility (p. 62) No details are provided for this


entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
Ansys.Mechanical.Graphics Namespace

BoundaryConditionVisibility
No details are provided for this entry.

Declaration Syntax
public BoundaryConditionVisibilityDictionary BoundaryConditionVisibility { get; }

AnimationExportSettings
No details are provided for this entry.

Declaration Syntax
public class AnimationExportSettings

Table 49: Members

Constructor AnimationExportSettings(int, int) (p. 62) Specifies the Animation Export File
Properties.
Property Height (p. 62) Specifies the video height.
Property Width (p. 63) Specifies the video width.

AnimationExportSettings(int, int)
Specifies the Animation Export File Properties.

Declaration Syntax
public AnimationExportSettings(int width, int height)

Parameters
width(int)

No details are provided for this entry.

height(int)

No details are provided for this entry.

Height
Specifies the video height.

Declaration Syntax
public int Height { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
AnnotationPreferences

Width
Specifies the video width.

Declaration Syntax
public int Width { set;get; }

AnnotationPreferences
No details are provided for this entry.

Declaration Syntax
public class AnnotationPreferences

Table 50: Members

Property PointMassSize (p. 64) Sets the size for point mass annotation. (Small-Large
; 1-100)
Property ShowAllAnnotations (p. 64) Sets the visibility of all annotations.
Property ShowBeams (p. 64) Sets the visibility of beam annotations.
Property ShowBearings (p. 64) Sets the visibility of bearing annotations.
Property ShowBodyScopings (p. 64) Sets the visibility of body scoping annotations.
Property ShowCracks (p. 64) Sets the visibility of crack annotations.
Property ShowCustomAnnotations (p. 65) Sets the visibility of user defined annotations.
Property ShowElementNumbers (p. 65) Sets the visibility of mesh element numbers in
named Selection, mesh, and result displays.
Property ShowForceArrows (p. 65) Sets the visibility of force arrows on surface reaction.
Property ShowLabels (p. 65) Sets the visibility of annotation labels.
Property ShowMeshAnnotations (p. 65) Sets the visibility of mesh node and mesh element
annotations in named selection displays.
Property ShowNamedSelectionElements (p. 65) Sets the visibility of elements for all items in the
named selection group.
Property ShowNodeNumbers (p. 66) Sets the visibility of mesh node numbers in named
selection, mesh, and result displays.
Property ShowPointMasses (p. 66) Sets the visibility of point mass annotations.
Property ShowSprings (p. 66) Sets the visibility of spring annotations.
Property SpringSize (p. 66) Sets the size for spring annotation. (Small-Large ;
1-100)
Method SetElementNumbering(int, int, Sets the begin, end and increment values to display
int) (p. 66) element numbering.
Method SetNodeNumbering(int, int, Sets the begin, end and increment values to display
int) (p. 67) node numbering.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
Ansys.Mechanical.Graphics Namespace

PointMassSize
Sets the size for point mass annotation. (Small-Large ; 1-100)

Declaration Syntax
public int PointMassSize { set;get; }

ShowAllAnnotations
Sets the visibility of all annotations.

Declaration Syntax
public bool ShowAllAnnotations { set;get; }

ShowBeams
Sets the visibility of beam annotations.

Declaration Syntax
public bool ShowBeams { set;get; }

ShowBearings
Sets the visibility of bearing annotations.

Declaration Syntax
public bool ShowBearings { set;get; }

ShowBodyScopings
Sets the visibility of body scoping annotations.

Declaration Syntax
public bool ShowBodyScopings { set;get; }

ShowCracks
Sets the visibility of crack annotations.

Declaration Syntax
public bool ShowCracks { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
64 of ANSYS, Inc. and its subsidiaries and affiliates.
AnnotationPreferences

ShowCustomAnnotations
Sets the visibility of user defined annotations.

Declaration Syntax
public bool ShowCustomAnnotations { set;get; }

ShowElementNumbers
Sets the visibility of mesh element numbers in named Selection, mesh, and result displays.

Declaration Syntax
public bool ShowElementNumbers { set;get; }

ShowForceArrows
Sets the visibility of force arrows on surface reaction.

Declaration Syntax
public bool ShowForceArrows { set;get; }

ShowLabels
Sets the visibility of annotation labels.

Declaration Syntax
public bool ShowLabels { set;get; }

ShowMeshAnnotations
Sets the visibility of mesh node and mesh element annotations in named selection displays.

Declaration Syntax
public bool ShowMeshAnnotations { set;get; }

ShowNamedSelectionElements
Sets the visibility of elements for all items in the named selection group.

Declaration Syntax
public bool ShowNamedSelectionElements { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
Ansys.Mechanical.Graphics Namespace

ShowNodeNumbers
Sets the visibility of mesh node numbers in named selection, mesh, and result displays.

Declaration Syntax
public bool ShowNodeNumbers { set;get; }

ShowPointMasses
Sets the visibility of point mass annotations.

Declaration Syntax
public bool ShowPointMasses { set;get; }

ShowSprings
Sets the visibility of spring annotations.

Declaration Syntax
public bool ShowSprings { set;get; }

SpringSize
Sets the size for spring annotation. (Small-Large ; 1-100)

Declaration Syntax
public int SpringSize { set;get; }

SetElementNumbering(int, int, int)


Sets the begin, end and increment values to display element numbering.

Declaration Syntax
public void SetElementNumbering(int begin, int end, int inc)

Parameters
begin(int)

No details are provided for this entry.

end(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
GlobalLegendSettings

inc(int)

No details are provided for this entry.

SetNodeNumbering(int, int, int)


Sets the begin, end and increment values to display node numbering.

Declaration Syntax
public void SetNodeNumbering(int begin, int end, int inc)

Parameters
begin(int)

No details are provided for this entry.

end(int)

No details are provided for this entry.

inc(int)

No details are provided for this entry.

GlobalLegendSettings
Defines global legend settings.

Declaration Syntax
public class GlobalLegendSettings

Table 51: Members

Property LegendOrientation (p. 67) Whether the orientation of the legend.


Property ShowDateAndTime (p. 68) Whether the date and time of the legend is
shown.
Property ShowDeformingScaling (p. 68) Whether the Deformation Scaling is shown.
Property ShowMinMax (p. 68) Whether the Min and Max value are shown.

LegendOrientation
Whether the orientation of the legend.

Declaration Syntax
public LegendOrientationType LegendOrientation { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
Ansys.Mechanical.Graphics Namespace

ShowDateAndTime
Whether the date and time of the legend is shown.

Declaration Syntax
public bool ShowDateAndTime { set;get; }

ShowDeformingScaling
Whether the Deformation Scaling is shown.

Declaration Syntax
public bool ShowDeformingScaling { set;get; }

ShowMinMax
Whether the Min and Max value are shown.

Declaration Syntax
public bool ShowMinMax { set;get; }

Graphics3DExportSettings
No details are provided for this entry.

Declaration Syntax
public class Graphics3DExportSettings

Table 52: Members

Constructor Graphics3DExportSettings() (p. 68) Specifies the settings when exporting 3D


Graphics.
Property Background (p. 69) Specifies the background color.

Graphics3DExportSettings()
Specifies the settings when exporting 3D Graphics.

Declaration Syntax
public Graphics3DExportSettings()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
68 of ANSYS, Inc. and its subsidiaries and affiliates.
GraphicsImageExportSettings

Background
Specifies the background color.

Declaration Syntax
public GraphicsBackgroundType Background { set;get; }

GraphicsImageExportSettings
No details are provided for this entry.

Declaration Syntax
public class GraphicsImageExportSettings

Table 53: Members

Constructor GraphicsImageExportSettings() (p. 70) Creates a new GraphicsImageExportSettings


instance.
Property AppendGraph (p. 70) Specifies whether to append the viewport
graph(s) to the exported image. Defaults to false.
Property Background (p. 70) Specifies the background color. Defaults to
GraphicsAppearanceSetting.
Property Capture (p. 70) Specifies what to include in the capture. Defaults
to ImageAndLegend.
Property CurrentGraphicsDisplay (p. 70) Specifies whether to use the current graphics
display settings. Defaults to true.
Property FontMagnification (p. 70) Specifies the font magnification factor. Defaults
to 1.0.
Property Height (p. 71) Specifies the image height. Defaults to 0. If width
AND height are zero, this uses the current
dimensions. If only one of the two are nonzero,
the current dimension’s ratio is used along with
the nonzero of the two properties to determine
the computed value of the zero property.
Property Resolution (p. 71) Specifies the resolution type. Defaults to
NormalResolution.
Property Width (p. 71) Specifies the image width. Defaults to 0. If width
AND height are zero, this uses the current
dimensions. If only one of the two are nonzero,
the current dimension’s ratio is used along with
the nonzero of the two properties to determine
the computed value of the zero property.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
Ansys.Mechanical.Graphics Namespace

GraphicsImageExportSettings()
Creates a new GraphicsImageExportSettings instance.

Declaration Syntax
public GraphicsImageExportSettings()

AppendGraph
Specifies whether to append the viewport graph(s) to the exported image. Defaults to false.

Declaration Syntax
public bool AppendGraph { set;get; }

Background
Specifies the background color. Defaults to GraphicsAppearanceSetting.

Declaration Syntax
public GraphicsBackgroundType Background { set;get; }

Capture
Specifies what to include in the capture. Defaults to ImageAndLegend.

Declaration Syntax
public GraphicsCaptureType Capture { set;get; }

CurrentGraphicsDisplay
Specifies whether to use the current graphics display settings. Defaults to true.

Declaration Syntax
public bool CurrentGraphicsDisplay { set;get; }

FontMagnification
Specifies the font magnification factor. Defaults to 1.0.

Declaration Syntax
public double FontMagnification { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
70 of ANSYS, Inc. and its subsidiaries and affiliates.
GraphicsViewportsExportSettings

Height
Specifies the image height. Defaults to 0. If width AND height are zero, this uses the current dimensions.
If only one of the two are nonzero, the current dimension’s ratio is used along with the nonzero of
the two properties to determine the computed value of the zero property.

Declaration Syntax
public int Height { set;get; }

Resolution
Specifies the resolution type. Defaults to NormalResolution.

Declaration Syntax
public GraphicsResolutionType Resolution { set;get; }

Width
Specifies the image width. Defaults to 0. If width AND height are zero, this uses the current dimensions.
If only one of the two are nonzero, the current dimension’s ratio is used along with the nonzero of
the two properties to determine the computed value of the zero property.

Declaration Syntax
public int Width { set;get; }

GraphicsViewportsExportSettings
Settings object to control Graphics.ExportViewports behavior.

Declaration Syntax
public class GraphicsViewportsExportSettings : GraphicsImageExportSettings

Table 54: Members

Constructor GraphicsViewportsExportSettings() (p. 73) Creates a new


GraphicsViewportsExportSettings instance.
Property AppendGraph (p. 70) Specifies whether to append the viewport
graph(s) to the exported image. Defaults to
false.

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property Background (p. 70) Specifies the background color. Defaults to
GraphicsAppearanceSetting.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
Ansys.Mechanical.Graphics Namespace

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property BorderStyle (p. 73) Specifies which borders to add, if any, to the
exported viewports image. Border style enum
values can be combined via bitwise-or ( | ).
Defaults to None.
Property Capture (p. 70) Specifies what to include in the capture.
Defaults to ImageAndLegend.

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property CurrentGraphicsDisplay (p. 70) Specifies whether to use the current graphics
display settings. Defaults to true.

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property FontMagnification (p. 70) Specifies the font magnification factor.
Defaults to 1.0.

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property Height (p. 71) Specifies the image height. Defaults to 0. If
width AND height are zero, this uses the
current dimensions. If only one of the two
are nonzero, the current dimension’s ratio is
used along with the nonzero of the two
properties to determine the computed value
of the zero property.

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property Resolution (p. 71) Specifies the resolution type. Defaults to
NormalResolution.

(Inherited from
GraphicsImageExportSettings (p. 69).)
Property Width (p. 71) Specifies the image width. Defaults to 0. If
width AND height are zero, this uses the
current dimensions. If only one of the two
are nonzero, the current dimension’s ratio is
used along with the nonzero of the two
properties to determine the computed value
of the zero property.

(Inherited from
GraphicsImageExportSettings (p. 69).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
72 of ANSYS, Inc. and its subsidiaries and affiliates.
Point

GraphicsViewportsExportSettings()
Creates a new GraphicsViewportsExportSettings instance.

Declaration Syntax
public GraphicsViewportsExportSettings()

BorderStyle
Specifies which borders to add, if any, to the exported viewports image. Border style enum values
can be combined via bitwise-or ( | ). Defaults to None.

Declaration Syntax
public GraphicsViewportsExportBorderStyle BorderStyle { set;get; }

Point
No details are provided for this entry.

Declaration Syntax
public class Point : IEquatable<Point>

Table 55: Members

Constructor Point(IList<object>, string) (p. 73) Creates a new Point.


Property Location (p. 74) The location of the Point.
Property Unit (p. 74) The length unit of the Point.
Method ConvertUnit(Point, string) (p. 74) Returns a new Point given new
unit.
Method Equals(object) (p. 74) Object.Equals(object o) override
Method GetHashCode() (p. 75) Object.GetHashCode() override
operator op_Equality(Point, Point) (p. 75) Equal operator
operator op_Inequality(Point, Point) (p. 75) Not-Equal operator

Point(IList<object>, string)
Creates a new Point.

Declaration Syntax
public Point(IList<object> location, string lengthUnit)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
Ansys.Mechanical.Graphics Namespace

Parameters
location(IList<object>)

The location of the point.

lengthUnit(string)

The unit of measurement.

Location
The location of the Point.

Declaration Syntax
public IList<double> Location { set;get; }

Unit
The length unit of the Point.

Declaration Syntax
public string Unit { set;get; }

ConvertUnit(Point, string)
Returns a new Point given new unit.

Declaration Syntax
public static Point ConvertUnit(Point inPoint, string outputUnit)

Parameters
inPoint(Point)

No details are provided for this entry.

outputUnit(string)

No details are provided for this entry.

Equals(object)
Object.Equals(object o) override

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
74 of ANSYS, Inc. and its subsidiaries and affiliates.
Point

Declaration Syntax
public override bool Equals(object o)

Parameters
o(object)

No details are provided for this entry.

GetHashCode()
Object.GetHashCode() override

Declaration Syntax
public override int GetHashCode()

op_Equality(Point, Point)
Equal operator

Declaration Syntax
public static bool operator ==(Point a, Point b)

Parameters
a(Point)

No details are provided for this entry.

b(Point)

No details are provided for this entry.

op_Inequality(Point, Point)
Not-Equal operator

Declaration Syntax
public static bool operator !=(Point a, Point b)

Parameters
a(Point)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
Ansys.Mechanical.Graphics Namespace

b(Point)

No details are provided for this entry.

ResultAnimationOptions
No details are provided for this entry.

Declaration Syntax
public class ResultAnimationOptions

Table 56: Members

Property DisplacementTraces (p. 76) Gets or Sets if the Displacement Traces are
Enabled/Disabled
Property Duration (p. 76) Gets or Sets the Duration for Result Animation.
Property FitDeformationScalingToAnimation (p. 77) Gets or Sets if the Animation Displacement Fits
for full range of Time Steps in the Screen.
Property NumberOfFrames (p. 77) Gets or Sets the Number Of Frames for
Distributed Result Animation.
Property RangeType (p. 77) Gets or Sets the Range Type for Result
Animation.
Property TimeDecay (p. 77) Gets or Sets the Time Decay.
Property TimeDecayCycles (p. 77) Gets or Sets the Number of Cycles for Time
Decay.
Property UpdateContourRangeAtEachFrame (p. 77) Gets or Sets if the Legend Contours will Update
at Each Frame.

DisplacementTraces
Gets or Sets if the Displacement Traces are Enabled/Disabled

Declaration Syntax
public bool DisplacementTraces { set;get; }

Duration
Gets or Sets the Duration for Result Animation.

Declaration Syntax
public Quantity Duration { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
76 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultAnimationOptions

FitDeformationScalingToAnimation
Gets or Sets if the Animation Displacement Fits for full range of Time Steps in the Screen.

Declaration Syntax
public bool FitDeformationScalingToAnimation { set;get; }

NumberOfFrames
Gets or Sets the Number Of Frames for Distributed Result Animation.

Declaration Syntax
public int NumberOfFrames { set;get; }

RangeType
Gets or Sets the Range Type for Result Animation.

Declaration Syntax
public ResultAnimationRangeType RangeType { set;get; }

TimeDecay
Gets or Sets the Time Decay.

Declaration Syntax
public bool TimeDecay { set;get; }

TimeDecayCycles
Gets or Sets the Number of Cycles for Time Decay.

Declaration Syntax
public int TimeDecayCycles { set;get; }

UpdateContourRangeAtEachFrame
Gets or Sets if the Legend Contours will Update at Each Frame.

Declaration Syntax
public bool UpdateContourRangeAtEachFrame { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 77
Ansys.Mechanical.Graphics Namespace

ResultPreference
No details are provided for this entry.

Declaration Syntax
public class ResultPreference

Table 57: Members

Property CappingType (p. 78) Sets the result capping type.


Property ContourView (p. 78) Sets the result contour view.
Property DeformationScaleMultiplier (p. 78) Sets the deformation scale multiplier.
Property DeformationScaling (p. 79) Sets the deformation scale multiplier to either
AutoScale or TrueScale.
Property ExtraModelDisplay (p. 79) Sets the result edge display option.
Property GeometryView (p. 79) Sets the result geometry view.
Property IsoSurfaceValue (p. 79) Sets the capping value for capped iso surface view .
Property ScopingDisplay (p. 79) Sets the result scoping display.
Property ShowMaximum (p. 79) Displays the result maximum value annotation label.
Property ShowMinimum (p. 80) Displays the result minimum value annotation label.

CappingType
Sets the result capping type.

Declaration Syntax
public CappingType CappingType { set;get; }

ContourView
Sets the result contour view.

Declaration Syntax
public ContourView ContourView { set;get; }

DeformationScaleMultiplier
Sets the deformation scale multiplier.

Declaration Syntax
public double DeformationScaleMultiplier { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
78 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultPreference

DeformationScaling
Sets the deformation scale multiplier to either AutoScale or TrueScale.

Declaration Syntax
public DeformationScaling DeformationScaling { set;get; }

ExtraModelDisplay
Sets the result edge display option.

Declaration Syntax
public ExtraModelDisplay ExtraModelDisplay { set;get; }

GeometryView
Sets the result geometry view.

Declaration Syntax
public GeometryView GeometryView { set;get; }

IsoSurfaceValue
Sets the capping value for capped iso surface view .

Declaration Syntax
public Quantity IsoSurfaceValue { set;get; }

ScopingDisplay
Sets the result scoping display.

Declaration Syntax
public ScopingDisplay ScopingDisplay { set;get; }

ShowMaximum
Displays the result maximum value annotation label.

Declaration Syntax
public bool ShowMaximum { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
Ansys.Mechanical.Graphics Namespace

ShowMinimum
Displays the result minimum value annotation label.

Declaration Syntax
public bool ShowMinimum { set;get; }

SectionPlane
Represents a SectionPlane object. This object holds properties of the Plane.

Declaration Syntax
public class SectionPlane : IMechanicalSectionPlane, IEquatable<SectionPlane>

Table 58: Members

Constructor SectionPlane() (p. 80) Creates a SectionPlane Object


Constructor SectionPlane(Point, Vector3D, Creates a SectionPlane Object with the specified
string, SectionPlaneType, property values
bool) (p. 80)
Property Active (p. 81) Gets or Sets the Active State of the Section Plane
Property Center (p. 81) Gets or Sets the Center point of the Section Plane
Property Direction (p. 81) Gets or Sets the Direction(Normal) of the Section
Plane
Property Name (p. 82) Gets or Sets the Name of the Section Plane
Property Type (p. 82) Gets or Sets the SectionPlane Type of the Section
Plane
Method Equals(SectionPlane) (p. 82) Indicates whether the current SectionPlane
properties are equal to the properties of another
SectionPlane object.

SectionPlane()
Creates a SectionPlane Object

Declaration Syntax
public SectionPlane()

SectionPlane(Point, Vector3D, string, SectionPlaneType, bool)


Creates a SectionPlane Object with the specified property values

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
80 of ANSYS, Inc. and its subsidiaries and affiliates.
SectionPlane

Declaration Syntax
public SectionPlane(Point center, Vector3D direction, string name, SectionPlaneType type, bool active)

Parameters
center(Point)

Center of the Section Plane

direction(Vector3D)

Direction of the Section Plane

name(string)

Name for the Section Plane

type(SectionPlaneType)

Type of cut for the Section Plane (default = AlongDirection)

active(bool)

If true (default = false), Graphics shows this Section Plane

Active
Gets or Sets the Active State of the Section Plane

Declaration Syntax
public bool Active { set;get; }

Center
Gets or Sets the Center point of the Section Plane

Declaration Syntax
public Point Center { set;get; }

Direction
Gets or Sets the Direction(Normal) of the Section Plane

Declaration Syntax
public Vector3D Direction { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 81
Ansys.Mechanical.Graphics Namespace

Name
Gets or Sets the Name of the Section Plane

Declaration Syntax
public string Name { set;get; }

Type
Gets or Sets the SectionPlane Type of the Section Plane

Declaration Syntax
public SectionPlaneType Type { set;get; }

Equals(SectionPlane)
Indicates whether the current SectionPlane properties are equal to the properties of another Section-
Plane object.

Declaration Syntax
public virtual bool Equals(SectionPlane sectionPlane)

Parameters
sectionPlane(SectionPlane)

A SectionPlane Object

SectionPlanes
Represents the collection of section planes used by graphics

Declaration Syntax
public class SectionPlanes : ICollection<SectionPlane>, IEnumerable<SectionPlane>, IEnumerable, IRe-
adOnlyList<SectionPlane>, IReadOnlyCollection<SectionPlane>

Table 59: Members

Property Capping (p. 83) Gets or Sets the Capping style of the Section Plane
Property Count (p. 83) The number of section planes in the collection.
Property ShowWholeElement (p. 83) Gets or Sets the Element Visibility of the Section Plane
Method Add(SectionPlane) (p. 83) Adds the given SectionPlane object to the collection to
modify the view. Currently only 6 SectionPlane objects in
the collection can be activated at once.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
82 of ANSYS, Inc. and its subsidiaries and affiliates.
SectionPlanes

Method Clear() (p. 83) Clears the collection of all SectionPlane objects.
Method Remove(SectionPlane) (p. 84) Removes the requested SectionPlane from the collection.
Method RemoveAt(int) (p. 84) Removes the SectionPlane at the given index.

Capping
Gets or Sets the Capping style of the Section Plane

Declaration Syntax
public SectionPlaneCappingType Capping { set;get; }

Count
The number of section planes in the collection.

Declaration Syntax
public int Count { get; }

ShowWholeElement
Gets or Sets the Element Visibility of the Section Plane

Declaration Syntax
public bool ShowWholeElement { set;get; }

Add(SectionPlane)
Adds the given SectionPlane object to the collection to modify the view. Currently only 6 SectionPlane
objects in the collection can be activated at once.

Declaration Syntax
public virtual void Add(SectionPlane sectionPlane)

Parameters
sectionPlane(SectionPlane)

The sectionPlane object to add

Clear()
Clears the collection of all SectionPlane objects.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
Ansys.Mechanical.Graphics Namespace

Declaration Syntax
public virtual void Clear()

Remove(SectionPlane)
Removes the requested SectionPlane from the collection.

Declaration Syntax
public virtual bool Remove(SectionPlane sectionPlane)

Parameters
sectionPlane(SectionPlane)

No details are provided for this entry.

RemoveAt(int)
Removes the SectionPlane at the given index.

Declaration Syntax
public void RemoveAt(int index)

Parameters
index(int)

The index of the SectionPlane to remove

VectorDisplay
No details are provided for this entry.

Declaration Syntax
public class VectorDisplay

Table 60: Members

Property ControlDisplayDensity (p. 85) Allows control of the vector display


density.
Property DisplayDensity (p. 85) Sets the vector display density in
percentage.
Property DisplayType (p. 85) Sets the vector display type.
Property LengthMultiplier (p. 85) Sets the vector length multiplier.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorDisplay

Property LengthType (p. 85) Sets the result vector length type.
Property ShowTriadXAxis (p. 86) Displays the X axis vector of the
triad/tensor.
Property ShowTriadYAxis (p. 86) Displays the Y axis vector of the
triad/tensor.
Property ShowTriadZAxis (p. 86) Displays the Z axis vector of the
triad/tensor.

ControlDisplayDensity
Allows control of the vector display density.

Declaration Syntax
public bool ControlDisplayDensity { set;get; }

DisplayDensity
Sets the vector display density in percentage.

Declaration Syntax
public double DisplayDensity { set;get; }

DisplayType
Sets the vector display type.

Declaration Syntax
public VectorDisplayType DisplayType { set;get; }

LengthMultiplier
Sets the vector length multiplier.

Declaration Syntax
public double LengthMultiplier { set;get; }

LengthType
Sets the result vector length type.

Declaration Syntax
public VectorLengthType LengthType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
Ansys.Mechanical.Graphics Namespace

ShowTriadXAxis
Displays the X axis vector of the triad/tensor.

Declaration Syntax
public bool ShowTriadXAxis { set;get; }

ShowTriadYAxis
Displays the Y axis vector of the triad/tensor.

Declaration Syntax
public bool ShowTriadYAxis { set;get; }

ShowTriadZAxis
Displays the Z axis vector of the triad/tensor.

Declaration Syntax
public bool ShowTriadZAxis { set;get; }

ViewOptions
No details are provided for this entry.

Declaration Syntax
public class ViewOptions

Table 61: Members

Property AnnotationPreferences (p. 87) No details are provided for this entry.
Property ClusteredVertexTolerance (p. 87) Sets the clustered vertices custom tolerance value.
Property DisplayGraphOverlay (p. 87) Display Graph overlay in the current viewport.
Property ModelColoring (p. 87) Sets the Model display Coloring.
Property ModelDisplay (p. 88) Sets the model display option.
Property ResultPreference (p. 88) No details are provided for this entry.
Property ShowBeamThickness (p. 88) Displays the thickness of beams.
Property ShowClusteredVertices (p. 88) Displays all closely clustered vertices of the model.
Property ShowCoordinateSystems (p. 88) Displays all coordinate system defined.
Property ShowEdgeDirection (p. 88) Displays the edge direction arrow.
Property ShowLegend (p. 89) Displays the legend.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
86 of ANSYS, Inc. and its subsidiaries and affiliates.
ViewOptions

Property ShowMesh (p. 89) Display the model's mesh.


Property ShowMeshConnection (p. 89) Displays edge connection using a color scheme
based on the mesh connection information.
Property ShowRandomColors (p. 89) Sets random colors for each object of the application.
Property ShowRemotePointConnections (p. 89) Displays the Remote Point Connections.
Property ShowResultVectors (p. 89) Displays the result vectors.
Property ShowRuler (p. 90) Displays the ruler.
Property ShowShellThickness (p. 90) Displays the thickness of shells.
Property ShowSPHExpansion (p. 90) Displays the expansion for SPH elements.
Property ShowThickEdgeScoping (p. 90) Thicken the display of edge scoping.
Property ShowTriad (p. 90) Displays the triad.
Property ShowVertices (p. 90) Display all the vertices of the model.
Property VectorDisplay (p. 91) No details are provided for this entry.
Method RescaleAnnotations() (p. 91) Rescale size of annotation following a zoom in or
zoom out of the model.

AnnotationPreferences
No details are provided for this entry.

Declaration Syntax
public AnnotationPreferences AnnotationPreferences { get; }

ClusteredVertexTolerance
Sets the clustered vertices custom tolerance value.

Declaration Syntax
public Quantity ClusteredVertexTolerance { set;get; }

DisplayGraphOverlay
Display Graph overlay in the current viewport.

Declaration Syntax
public bool DisplayGraphOverlay { set;get; }

ModelColoring
Sets the Model display Coloring.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
Ansys.Mechanical.Graphics Namespace

Declaration Syntax
public ModelColoring ModelColoring { set;get; }

ModelDisplay
Sets the model display option.

Declaration Syntax
public ModelDisplay ModelDisplay { set;get; }

ResultPreference
No details are provided for this entry.

Declaration Syntax
public ResultPreference ResultPreference { get; }

ShowBeamThickness
Displays the thickness of beams.

Declaration Syntax
public bool ShowBeamThickness { set;get; }

ShowClusteredVertices
Displays all closely clustered vertices of the model.

Declaration Syntax
public bool ShowClusteredVertices { set;get; }

ShowCoordinateSystems
Displays all coordinate system defined.

Declaration Syntax
public bool ShowCoordinateSystems { set;get; }

ShowEdgeDirection
Displays the edge direction arrow.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
88 of ANSYS, Inc. and its subsidiaries and affiliates.
ViewOptions

Declaration Syntax
public bool ShowEdgeDirection { set;get; }

ShowLegend
Displays the legend.

Declaration Syntax
public bool ShowLegend { set;get; }

ShowMesh
Display the model's mesh.

Declaration Syntax
public bool ShowMesh { set;get; }

ShowMeshConnection
Displays edge connection using a color scheme based on the mesh connection information.

Declaration Syntax
public bool ShowMeshConnection { set;get; }

ShowRandomColors
Sets random colors for each object of the application.

Declaration Syntax
public bool ShowRandomColors { set;get; }

ShowRemotePointConnections
Displays the Remote Point Connections.

Declaration Syntax
public bool ShowRemotePointConnections { set;get; }

ShowResultVectors
Displays the result vectors.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
Ansys.Mechanical.Graphics Namespace

Declaration Syntax
public bool ShowResultVectors { set;get; }

ShowRuler
Displays the ruler.

Declaration Syntax
public bool ShowRuler { set;get; }

ShowShellThickness
Displays the thickness of shells.

Declaration Syntax
public bool ShowShellThickness { set;get; }

ShowSPHExpansion
Displays the expansion for SPH elements.

Declaration Syntax
public bool ShowSPHExpansion { set;get; }

ShowThickEdgeScoping
Thicken the display of edge scoping.

Declaration Syntax
public bool ShowThickEdgeScoping { set;get; }

ShowTriad
Displays the triad.

Declaration Syntax
public bool ShowTriad { set;get; }

ShowVertices
Display all the vertices of the model.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
90 of ANSYS, Inc. and its subsidiaries and affiliates.
ViewOptions

Declaration Syntax
public bool ShowVertices { set;get; }

VectorDisplay
No details are provided for this entry.

Declaration Syntax
public VectorDisplay VectorDisplay { get; }

RescaleAnnotations()
Rescale size of annotation following a zoom in or zoom out of the model.

Declaration Syntax
public void RescaleAnnotations()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
92 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.Graphics.Tools Namespace
Declaration Syntax
namespace Ansys.Mechanical.Graphics.Tools

Table 62: Members

CurrentLegendSettings (p. 93) Represents a CurrentLegendSettings object. This object holds


properties of the CurrentLegendSettings.
LegendSettings (p. 99) Represents a LegendSettings object. This object holds properties of
the Standalone LegendSettings.

CurrentLegendSettings
Represents a CurrentLegendSettings object. This object holds properties of the CurrentLegendSettings.

Declaration Syntax
public class CurrentLegendSettings

Table 63: Members

Property AllScientificNotation (p. 94) Whether the result values are displayed in scientific
notation.
Property ColorScheme (p. 94) Color Scheme for the legend.
Property Digits (p. 94) Number of significant digits(min:2, max:8).
Property HighFidelity (p. 94) Whether to replot and improve the synchronization
of the result values.
Property LogarithmicScale (p. 95) Whether the result values are distributed in a
Logarithmic scale.
Property NumberOfBands (p. 95) Number of bands on the legend (min:3, max:30). Bands
are added/removed from the top of the legend.
Property SemiTransparency (p. 95) Whether the legend is semi-transparent.
Method GetBandColor(int) (p. 95) Gets the color of the specified band.
Method GetBandColorAuto(int) (p. 95) Gets whether the specified band is set to Automatic
or not.
Method GetLowerBandValueAuto(int) (p. 96) Gets whether the specified lower band value is set to
Automatic or not.
Method GetLowerBound(int) (p. 96) Gets lower bound value of the specified band.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 93
Ansys.Mechanical.Graphics.Tools Namespace

Method GetUpperBandValueAuto(int) (p. 96) Gets whether the specified upper band value is set to
Automatic or not.
Method GetUpperBound(int) (p. 97) Gets upper bound value of the specified band.
Method MakeCopy() (p. 97) Makes a copy of the CurrentLegendSettings object.
Method Reset() (p. 97) Resets all legend customizations into default values.
Method ResetColors() (p. 97) Resets all colors to default values.
Method SetBandColor(int, uint) (p. 97) Sets the color of the specified band.
Method SetBandColorAuto(int, bool) (p. 98) Sets the specified band to Automatic.
Method SetLowerBound(int, Sets lower bound value of the specified band.
Quantity) (p. 98)
Method SetUpperBound(int, Sets upper bound value of the specified band.
Quantity) (p. 98)

AllScientificNotation
Whether the result values are displayed in scientific notation.

Declaration Syntax
public bool AllScientificNotation { set;get; }

ColorScheme
Color Scheme for the legend.

Declaration Syntax
public LegendColorSchemeType ColorScheme { set;get; }

Digits
Number of significant digits(min:2, max:8).

Declaration Syntax
public int Digits { set;get; }

HighFidelity
Whether to replot and improve the synchronization of the result values.

Declaration Syntax
public bool HighFidelity { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
94 of ANSYS, Inc. and its subsidiaries and affiliates.
CurrentLegendSettings

LogarithmicScale
Whether the result values are distributed in a Logarithmic scale.

Declaration Syntax
public bool LogarithmicScale { set;get; }

NumberOfBands
Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend.

Declaration Syntax
public int NumberOfBands { set;get; }

SemiTransparency
Whether the legend is semi-transparent.

Declaration Syntax
public bool SemiTransparency { set;get; }

GetBandColor(int)
Gets the color of the specified band.

Declaration Syntax
public uint GetBandColor(int index)

Parameters
index(int)

No details are provided for this entry.

GetBandColorAuto(int)
Gets whether the specified band is set to Automatic or not.

Declaration Syntax
public bool GetBandColorAuto(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
Ansys.Mechanical.Graphics.Tools Namespace

Parameters
index(int)

No details are provided for this entry.

GetLowerBandValueAuto(int)
Gets whether the specified lower band value is set to Automatic or not.

Declaration Syntax
public bool GetLowerBandValueAuto(int index)

Parameters
index(int)

No details are provided for this entry.

GetLowerBound(int)
Gets lower bound value of the specified band.

Declaration Syntax
public Quantity GetLowerBound(int index)

Parameters
index(int)

No details are provided for this entry.

GetUpperBandValueAuto(int)
Gets whether the specified upper band value is set to Automatic or not.

Declaration Syntax
public bool GetUpperBandValueAuto(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
96 of ANSYS, Inc. and its subsidiaries and affiliates.
CurrentLegendSettings

GetUpperBound(int)
Gets upper bound value of the specified band.

Declaration Syntax
public Quantity GetUpperBound(int index)

Parameters
index(int)

No details are provided for this entry.

MakeCopy()
Makes a copy of the CurrentLegendSettings object.

Declaration Syntax
public LegendSettings MakeCopy()

Reset()
Resets all legend customizations into default values.

Declaration Syntax
public void Reset()

ResetColors()
Resets all colors to default values.

Declaration Syntax
public void ResetColors()

SetBandColor(int, uint)
Sets the color of the specified band.

Declaration Syntax
public void SetBandColor(int index, uint ColorValue)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
Ansys.Mechanical.Graphics.Tools Namespace

Parameters
index(int)

No details are provided for this entry.

ColorValue(uint)

No details are provided for this entry.

SetBandColorAuto(int, bool)
Sets the specified band to Automatic.

Declaration Syntax
public void SetBandColorAuto(int index, bool val)

Parameters
index(int)

No details are provided for this entry.

val(bool)

No details are provided for this entry.

SetLowerBound(int, Quantity)
Sets lower bound value of the specified band.

Declaration Syntax
public void SetLowerBound(int index, Quantity value)

Parameters
index(int)

No details are provided for this entry.

value(Quantity)

No details are provided for this entry.

SetUpperBound(int, Quantity)
Sets upper bound value of the specified band.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
98 of ANSYS, Inc. and its subsidiaries and affiliates.
LegendSettings

Declaration Syntax
public void SetUpperBound(int index, Quantity value)

Parameters
index(int)

No details are provided for this entry.

value(Quantity)

No details are provided for this entry.

LegendSettings
Represents a LegendSettings object. This object holds properties of the Standalone LegendSettings.

Declaration Syntax
public class LegendSettings

Table 64: Members

Property AllScientificNotation (p. 100) Whether the result values are displayed in scientific
notation.
Property ColorScheme (p. 100) Color Scheme for the legend.
Property Digits (p. 100) Number of significant digits (min:2 , max:8).
Property HighFidelity (p. 100) Whether to replot and improve the synchronization
of the result values.
Property LogarithmicScale (p. 100) Whether the result values are distributed in a
Logarithmic scale.
Property NumberOfBands (p. 101) Number of bands on the legend (min:3, max:30). Bands
are added/removed from the top of the legend.
Property SemiTransparency (p. 101) Whether the legend is semi-transparent.
Property Unit (p. 101) The unit for the legend.
Method GetBandColor(int) (p. 101) Gets the color of the specified band.
Method GetBandColorAuto(int) (p. 101) Gets whether the specified band is set to Automatic
or not.
Method GetLowerBandValueAuto(int) (p. 102) Gets whether the lower specified band value is set to
Automatic or not.
Method GetLowerBound(int) (p. 102) Gets lower bound value of the specified band.
Method GetUpperBandValueAuto(int) (p. 102) Gets whether the specified upper band value is set to
Automatic or not.
Method GetUpperBound(int) (p. 103) Gets upper bound value of the specified band.
Method Reset() (p. 103) Resets all legend customizations into default values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
Ansys.Mechanical.Graphics.Tools Namespace

Method ResetColors() (p. 103) Resets all colors to default values.


Method SetBandColor(int, uint) (p. 103) Sets the color of the specified band.
Method SetBandColorAuto(int, bool) (p. 104) Sets the specified band to Automatic.
Method SetLowerBound(int, Sets lower bound value of the specified band.
Quantity) (p. 104)
Method SetUpperBound(int, Sets upper bound value of the specified band.
Quantity) (p. 104)

AllScientificNotation
Whether the result values are displayed in scientific notation.

Declaration Syntax
public bool AllScientificNotation { set;get; }

ColorScheme
Color Scheme for the legend.

Declaration Syntax
public LegendColorSchemeType ColorScheme { set;get; }

Digits
Number of significant digits (min:2 , max:8).

Declaration Syntax
public int Digits { set;get; }

HighFidelity
Whether to replot and improve the synchronization of the result values.

Declaration Syntax
public bool HighFidelity { set;get; }

LogarithmicScale
Whether the result values are distributed in a Logarithmic scale.

Declaration Syntax
public bool LogarithmicScale { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
100 of ANSYS, Inc. and its subsidiaries and affiliates.
LegendSettings

NumberOfBands
Number of bands on the legend (min:3, max:30). Bands are added/removed from the top of the legend.

Declaration Syntax
public int NumberOfBands { set;get; }

SemiTransparency
Whether the legend is semi-transparent.

Declaration Syntax
public bool SemiTransparency { set;get; }

Unit
The unit for the legend.

Declaration Syntax
public string Unit { get; }

GetBandColor(int)
Gets the color of the specified band.

Declaration Syntax
public uint GetBandColor(int index)

Parameters
index(int)

No details are provided for this entry.

GetBandColorAuto(int)
Gets whether the specified band is set to Automatic or not.

Declaration Syntax
public bool GetBandColorAuto(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 101
Ansys.Mechanical.Graphics.Tools Namespace

Parameters
index(int)

No details are provided for this entry.

GetLowerBandValueAuto(int)
Gets whether the lower specified band value is set to Automatic or not.

Declaration Syntax
public bool GetLowerBandValueAuto(int index)

Parameters
index(int)

No details are provided for this entry.

GetLowerBound(int)
Gets lower bound value of the specified band.

Declaration Syntax
public Quantity GetLowerBound(int index)

Parameters
index(int)

No details are provided for this entry.

GetUpperBandValueAuto(int)
Gets whether the specified upper band value is set to Automatic or not.

Declaration Syntax
public bool GetUpperBandValueAuto(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
102 of ANSYS, Inc. and its subsidiaries and affiliates.
LegendSettings

GetUpperBound(int)
Gets upper bound value of the specified band.

Declaration Syntax
public Quantity GetUpperBound(int index)

Parameters
index(int)

No details are provided for this entry.

Reset()
Resets all legend customizations into default values.

Declaration Syntax
public void Reset()

ResetColors()
Resets all colors to default values.

Declaration Syntax
public void ResetColors()

SetBandColor(int, uint)
Sets the color of the specified band.

Declaration Syntax
public void SetBandColor(int index, uint colorValue)

Parameters
index(int)

No details are provided for this entry.

colorValue(uint)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 103
Ansys.Mechanical.Graphics.Tools Namespace

SetBandColorAuto(int, bool)
Sets the specified band to Automatic.

Declaration Syntax
public void SetBandColorAuto(int index, bool val)

Parameters
index(int)

No details are provided for this entry.

val(bool)

No details are provided for this entry.

SetLowerBound(int, Quantity)
Sets lower bound value of the specified band.

Declaration Syntax
public void SetLowerBound(int index, Quantity value)

Parameters
index(int)

No details are provided for this entry.

value(Quantity)

No details are provided for this entry.

SetUpperBound(int, Quantity)
Sets upper bound value of the specified band.

Declaration Syntax
public void SetUpperBound(int index, Quantity value)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
104 of ANSYS, Inc. and its subsidiaries and affiliates.
LegendSettings

value(Quantity)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 105
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
106 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.DataModel.ConstructionLines
Namespace
Declaration Syntax
namespace Ansys.Mechanical.DataModel.ConstructionLines

Table 65: Members

ConstructionLineHelper (p. 107) Helper to perform queries and modifications against a


ConstructionLine instance.
Plane (p. 111) A 2D sketching planes in a ConstructionLine instance.
PlaneType (p. 112) Enumeration for the possible edge vertex types that can be
represented.
Point (p. 113) A point in a ConstructionLine instance, may have an associated
edge vertex.
Point2DPlanar (p. 114) Basic data that describe a 2D point on a plane.
PointType (p. 115) Enumeration for the possible edge vertex types that can be
represented.

ConstructionLineHelper
Helper to perform queries and modifications against a ConstructionLine instance.

Declaration Syntax
public class ConstructionLineHelper

Table 66: Members

Method ClearExistingDataAndImportFromXML(ConstructionLine, Import global points and


string) (p. 108) connecting edges from an XML file.
Method ExportToXML(ConstructionLine, string) (p. 108) Collect all the edges and edge
vertices, then export them as
global points to an XML file.
Method GetContainedEdges(Plane) (p. 109) Get all the edges that have both
start and end edge vertices in the
given plane.
Method GetEdgesById(ConstructionLine, Get the IEdge representations of
IEnumerable<int>) (p. 109) the requested Construction Line
edges.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 107
Ansys.Mechanical.DataModel.ConstructionLines Namespace

Method GetEdgesUsingPoint(Point) (p. 109) Get a list of IEdge that use the
given Point.
Method GetEdgeVerticesById(ConstructionLine, Get the Point representations of
IEnumerable<int>) (p. 109) the requested Construction Line
edge vertices.
Method GetPlanesById(ConstructionLine, Get the Plane representations of
IEnumerable<int>) (p. 110) the requested Construction Line
planes.
Method GetRelatedEdges(Plane) (p. 110) Get all the edges that have only
edge vertex in the given plane.

ClearExistingDataAndImportFromXML(ConstructionLine, string)
Import global points and connecting edges from an XML file.

Declaration Syntax
public static IList<object> ClearExistingDataAndImportFromXML(ConstructionLine constructionLine,
string xmlFilePath)

Parameters
constructionLine(ConstructionLine)

The ConstructionLine instance.

xmlFilePath(string)

Full file path from which the data will be read. Note: A Python literal string (prefixed with an 'r'
character) may be required to prevent treating the backslash as an escape character.

ExportToXML(ConstructionLine, string)
Collect all the edges and edge vertices, then export them as global points to an XML file.

Declaration Syntax
public static void ExportToXML(ConstructionLine constructionLine, string xmlFilePath)

Parameters
constructionLine(ConstructionLine)

The ConstructionLine instance.

xmlFilePath(string)

Full file path to which the data will be written. Note: A Python literal string (prefixed with an 'r'
character) may be required to prevent treating the backslash as an escape character.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionLineHelper

GetContainedEdges(Plane)
Get all the edges that have both start and end edge vertices in the given plane.

Declaration Syntax
public static IList<object> GetContainedEdges(Plane plane)

Parameters
plane(Plane)

The Plane representation of a Construction Line plane,

GetEdgesById(ConstructionLine, IEnumerable<int>)
Get the IEdge representations of the requested Construction Line edges.

Declaration Syntax
public static IList<object> GetEdgesById(ConstructionLine constructionLine, IEnumerable<int>
edgeIdCollection)

Parameters
constructionLine(ConstructionLine)

The ConstructionLine instance.

edgeIdCollection(IEnumerable<int>)

A collection of edge IDs.

GetEdgesUsingPoint(Point)
Get a list of IEdge that use the given Point.

Declaration Syntax
public static IList<object> GetEdgesUsingPoint(Point point)

Parameters
point(Point)

A Point representation of a Construction Line edge vertex.

GetEdgeVerticesById(ConstructionLine, IEnumerable<int>)
Get the Point representations of the requested Construction Line edge vertices.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 109
Ansys.Mechanical.DataModel.ConstructionLines Namespace

Declaration Syntax
public static IList<object> GetEdgeVerticesById(ConstructionLine constructionLine, IEnumerable<int>
edgeVertexIdCollection)

Parameters
constructionLine(ConstructionLine)

The ConstructionLine instance.

edgeVertexIdCollection(IEnumerable<int>)

A collection of edge vertex IDs.

GetPlanesById(ConstructionLine, IEnumerable<int>)
Get the Plane representations of the requested Construction Line planes.

Declaration Syntax
public static IList<object> GetPlanesById(ConstructionLine constructionLine, IEnumerable<int>
planeIdCollection)

Parameters
constructionLine(ConstructionLine)

The ConstructionLine instance.

planeIdCollection(IEnumerable<int>)

No details are provided for this entry.

GetRelatedEdges(Plane)
Get all the edges that have only edge vertex in the given plane.

Declaration Syntax
public static IList<object> GetRelatedEdges(Plane plane)

Parameters
plane(Plane)

The Plane representation of a Construction Line plane,

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
110 of ANSYS, Inc. and its subsidiaries and affiliates.
Plane

Plane
A 2D sketching planes in a ConstructionLine instance.

Declaration Syntax
public class Plane : ConstructionLineAssociation, IEquatable<Plane>

Table 67: Members

Property Definition (p. 111) No details are provided for this entry.
Property Normal (p. 111) The plane's normal vector (Z axis orientation)
orientation.
Property Origin (p. 111) The global location of this plane's origin.
Property PrimaryAxisDirection (p. 112) The orientation of the plane's primary (X) axis
orientation.
Property SecondaryAxisDirection (p. 112) The orientation of the plane's secondary (Y) axis
orientation.
Property Type (p. 112) No details are provided for this entry.
Method Equivalent(Plane) (p. 112) Checks to see if another plane is equivalent to this one.

Definition
No details are provided for this entry.

Declaration Syntax
public object Definition { set;get; }

Normal
The plane's normal vector (Z axis orientation) orientation.

Declaration Syntax
public Vector3D Normal { get; }

Origin
The global location of this plane's origin.

Declaration Syntax
public Point3D Origin { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 111
Ansys.Mechanical.DataModel.ConstructionLines Namespace

PrimaryAxisDirection
The orientation of the plane's primary (X) axis orientation.

Declaration Syntax
public Vector3D PrimaryAxisDirection { get; }

SecondaryAxisDirection
The orientation of the plane's secondary (Y) axis orientation.

Declaration Syntax
public Vector3D SecondaryAxisDirection { get; }

Type
No details are provided for this entry.

Declaration Syntax
public PlaneType Type { get; }

Equivalent(Plane)
Checks to see if another plane is equivalent to this one.

Declaration Syntax
public bool Equivalent(Plane other)

Parameters
other(Plane)

Another `Plane` instance to compare equivalency against.

PlaneType
Enumeration for the possible edge vertex types that can be represented.

Declaration Syntax
public enum PlaneType

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
112 of ANSYS, Inc. and its subsidiaries and affiliates.
Point

Point
A point in a ConstructionLine instance, may have an associated edge vertex.

Declaration Syntax
public class Point : ConstructionLineAssociation, IEquatable<Point>

Table 68: Members

Property Definition (p. 113) No details are provided for this entry.
Property Location (p. 113) Get the global location of this point.
Property Type (p. 113) No details are provided for this entry.
Method Equivalent(Point) (p. 113) Checks to see if another point is equivalent to this
one.

Definition
No details are provided for this entry.

Declaration Syntax
public object Definition { set;get; }

Location
Get the global location of this point.

Declaration Syntax
public Point3D Location { get; }

Type
No details are provided for this entry.

Declaration Syntax
public PointType Type { get; }

Equivalent(Point)
Checks to see if another point is equivalent to this one.

Declaration Syntax
public bool Equivalent(Point other)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 113
Ansys.Mechanical.DataModel.ConstructionLines Namespace

Parameters
other(Point)

Another `Point` instance to compare equivalency against.

Point2DPlanar
Basic data that describe a 2D point on a plane.

Declaration Syntax
public sealed struct Point2DPlanar : ValueType

Table 69: Members

Constructor Point2DPlanar(Point2DPlanar) (p. 114) Construct a unique instance of the provided


Point2DPlanar.
Constructor Point2DPlanar(Point2D, Plane) (p. 114) Construct an instance using the provided
plane and location.
Field Location (p. 115) This point's 2D location within the plane.
Field Plane (p. 115) The sketch plane in which this point is
location.
Method GetGlobalLocation(Point2DPlanar) (p. 115) Get the global location of a Point2DPlanar.

Point2DPlanar(Point2DPlanar)
Construct a unique instance of the provided Point2DPlanar.

Declaration Syntax
public Point2DPlanar(Point2DPlanar point2DPlanar)

Parameters
point2DPlanar(Point2DPlanar)

The existing Point2DPlanar to copy.

Point2DPlanar(Point2D, Plane)
Construct an instance using the provided plane and location.

Declaration Syntax
public Point2DPlanar(Point2D location, Plane plane)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.
PointType

Parameters
location(Point2D)

The 2D location within the plane.

plane(Plane)

The plane in which this Point2dPlanar is located.

Location
This point's 2D location within the plane.

Declaration Syntax
public Point2D Location

Plane
The sketch plane in which this point is location.

Declaration Syntax
public Plane Plane

GetGlobalLocation(Point2DPlanar)
Get the global location of a Point2DPlanar.

Declaration Syntax
public static Point3D GetGlobalLocation(Point2DPlanar pointPlane)

Parameters
pointPlane(Point2DPlanar)

A Point2DPlanar instance.

PointType
Enumeration for the possible edge vertex types that can be represented.

Declaration Syntax
public enum PointType

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 115
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
116 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.Mechanical.DataModel.ConstructionLines.Edges
Namespace
Declaration Syntax
namespace Ansys.Mechanical.DataModel.ConstructionLines.Edges

Table 70: Members

IEdge (p. 117) Interface for edges created by ConstructionLine.


StraightLineEdge (p. 117) Representation of a straight line edge between to edge
vertices.

IEdge
Interface for edges created by ConstructionLine.

Declaration Syntax
public interface IEdge

Table 71: Members

Property Length (p. 117) Get the length of this


edge.

Length
Get the length of this edge.

Declaration Syntax
public Quantity Length { get; }

StraightLineEdge
Representation of a straight line edge between to edge vertices.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 117
Ansys.Mechanical.DataModel.ConstructionLines.Edges Namespace

Declaration Syntax
public class StraightLineEdge : ConstructionLineAssociation, IEquatable<StraightLineEdge>, IEdge

Table 72: Members

Property EndPoint (p. 118) A Point representing the end vertex of the
edge.
Property Length (p. 118) No details are provided for this entry.
Property StartPoint (p. 118) A Point representing the start vertex of an
edge.

EndPoint
A Point representing the end vertex of the edge.

Declaration Syntax
public Point EndPoint { set;get; }

Length
No details are provided for this entry.

Declaration Syntax
public Quantity Length { get; }

StartPoint
A Point representing the start vertex of an edge.

Declaration Syntax
public Point StartPoint { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
118 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.DesignModeler.Primitives.Sheet
Namespace
Declaration Syntax
namespace Ansys.ACT.DesignModeler.Primitives.Sheet

Table 73: Members

Cylinder (p. 119) Cylinder


Class

Cylinder
Cylinder Class

Declaration Syntax
public class Cylinder : Primitive, ISheetCylinder

Table 74: Members

Constructor Cylinder(GeometryBuilder, Create a new Cylinder.


IEnumerable<double>,
IEnumerable<double>, double) (p. 119)
Property Center (p. 120) Gets or sets the center of the cylinder.
Property Direction (p. 120) Gets or sets the axis of the cylinder.
Property Radius (p. 120) Gets or sets the radius of the cylinder.
Method Generate() (p. 120) Generate the Cylinder and return the
associated body.

Cylinder(GeometryBuilder, IEnumerable<double>, IEnumerable<double>,


double)
Create a new Cylinder.

Declaration Syntax
public Cylinder(GeometryBuilder builder, IEnumerable<double> center, IEnumerable<double> direction,
double radius)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 119
Ansys.ACT.DesignModeler.Primitives.Sheet Namespace

Parameters
builder(GeometryBuilder)

No details are provided for this entry.

center(IEnumerable<double>)

Center of the cylinder.

direction(IEnumerable<double>)

Axis of the cylinder.

radius(double)

Radius of the cylinder.

Center
Gets or sets the center of the cylinder.

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Direction
Gets or sets the axis of the cylinder.

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Radius
Gets or sets the radius of the cylinder.

Declaration Syntax
public double Radius { set;get; }

Generate()
Generate the Cylinder and return the associated body.

Declaration Syntax
public override IPSGeoBody Generate()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
120 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical

Table 75: Members

Transaction (p. 121) Speeds up bulk user interactions.


UnitsHelper (p. 121) Defines set of methods that can be used to find mechanical unit
information

Transaction
Speeds up bulk user interactions.

Declaration Syntax
public class Transaction : IDisposable

UnitsHelper
Defines set of methods that can be used to find mechanical unit information

Declaration Syntax
public class UnitsHelper

Table 76: Members

Method ConvertMechanicalUnitToCoreUnit(string, Takes input mechanical unit string and category


string) (p. 121) string And returns framework unit string which
can be used for conversion
Method GetValidQuantityNamesAndUnits() (p. 122) Retrieve a dictionary of quantity names to unit
strings. These quantity names represent valid
quantity names that can be used when defining
quantities in Mechanical ACT extensions.

ConvertMechanicalUnitToCoreUnit(string, string)
Takes input mechanical unit string and category string And returns framework unit string which can
be used for conversion

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 121
Ansys.ACT.Mechanical Namespace

Declaration Syntax
public static string ConvertMechanicalUnitToCoreUnit(string mechanicalUnit, string unitCategory)

Parameters
mechanicalUnit(string)

No details are provided for this entry.

unitCategory(string)

No details are provided for this entry.

GetValidQuantityNamesAndUnits()
Retrieve a dictionary of quantity names to unit strings. These quantity names represent valid quantity
names that can be used when defining quantities in Mechanical ACT extensions.

Declaration Syntax
public static IDictionary<string, string> GetValidQuantityNamesAndUnits()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
122 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Fields Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Fields

Table 77: Members

Field (p. 123) Represents a discrete or continuous field that can be used in a
component of a boundary condition from Mechanical, for instance.
Range (p. 124) Represents a domain for real values.
Variable (p. 125) Represents an object that is either an input or an output for a (See
Ansys.ACT.Mechanical.Fields.Variable.Field). Depending on whether it
is an input or output and on the way it is defined, this object holds
a series of discrete values or an expression that may involve other
variables.
VariableDefinitionType (p. 128) Defines the various ways to define the values of a variable.

Field
Represents a discrete or continuous field that can be used in a component of a boundary condition
from Mechanical, for instance.

Declaration Syntax
public sealed class Field

Table 78: Members

Property Inputs (p. 123) Gets the input variables of this


component.
Property Name (p. 124) Gets the name of this component.
Property Output (p. 124) Gets the output variable of this
component.

Inputs
Gets the input variables of this component.

Declaration Syntax
public IList<Variable> Inputs { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 123
Ansys.ACT.Mechanical.Fields Namespace

Name
Gets the name of this component.

Declaration Syntax
public string Name { get; }

Output
Gets the output variable of this component.

Declaration Syntax
public Variable Output { get; }

Range
Represents a domain for real values.

Declaration Syntax
public sealed struct Range : ValueType

Table 79: Members

Field Maximum (p. 124) No details are provided for this


entry.
Field Minimum (p. 124) No details are provided for this
entry.

Maximum
No details are provided for this entry.

Declaration Syntax
public readonly double Maximum

Minimum
No details are provided for this entry.

Declaration Syntax
public readonly double Minimum

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
124 of ANSYS, Inc. and its subsidiaries and affiliates.
Variable

Variable
Represents an object that is either an input or an output for a (See Ansys.ACT.Mechanical.Fields.Vari-
able.Field). Depending on whether it is an input or output and on the way it is defined, this object holds
a series of discrete values or an expression that may involve other variables.

Declaration Syntax
public class Variable

Table 80: Members

Property DefinitionType (p. 125) Gets a value that indicates how this variable is defined.
Property DiscreteValueCount (p. 126) Gets the number of discrete values of this variable.
Property DiscreteValues (p. 126) Gets or sets the discrete values of this variable or if this
variable represents a free degree of freedom.
null

Property Field (p. 126) Gets the owner field.


Property Formula (p. 126) Gets or sets the expression that is used to defined this
variable, or if the variable is not defined by a function.
null

Property Index (p. 126) Gets the index of this variable in its container field.
Property IsInput (p. 127) Gets a value indicating whether this variable is an input for
its container field. Otherwise, it is an output variable.
Property IsOutput (p. 127) Gets a value indicating whether this variable is an output for
its container field. Otherwise, it is an input variable.
Property MinMaxDiscreteValues (p. 127) Returns a Tuple containing the min and max values from the
list of discrete values.
Property Name (p. 127) Gets the variable's name.
Property QuantityName (p. 127) Gets the name of the quantity represented by this variable.
Property Range (p. 127) Gets the domain of validity for variable's value.
Property Unit (p. 128) Gets the symbol of the unit used to express this variable's
values.
Method GetDiscreteValue(int) (p. 128) Changes a value at a given position in the tabular definition
of the variable.
Method SetDiscreteValue(int, Changes a value at a given position in the tabular definition
Quantity) (p. 128) of the variable.

DefinitionType
Gets a value that indicates how this variable is defined.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 125
Ansys.ACT.Mechanical.Fields Namespace

Declaration Syntax
public VariableDefinitionType DefinitionType { set;get; }

DiscreteValueCount
Gets the number of discrete values of this variable.

Declaration Syntax
public int DiscreteValueCount { get; }

DiscreteValues
Gets or sets the discrete values of this variable or if this variable represents a free degree of freedom.
null

Declaration Syntax
public IList<Quantity> DiscreteValues { set;get; }

Field
Gets the owner field.

Declaration Syntax
public Field Field { get; }

Formula
Gets or sets the expression that is used to defined this variable, or if the variable is not defined by a
function.
null

Declaration Syntax
public string Formula { set;get; }

Index
Gets the index of this variable in its container field.

Declaration Syntax
public int Index { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
126 of ANSYS, Inc. and its subsidiaries and affiliates.
Variable

IsInput
Gets a value indicating whether this variable is an input for its container field. Otherwise, it is an
output variable.

Declaration Syntax
public bool IsInput { get; }

IsOutput
Gets a value indicating whether this variable is an output for its container field. Otherwise, it is an
input variable.

Declaration Syntax
public bool IsOutput { get; }

MinMaxDiscreteValues
Returns a Tuple containing the min and max values from the list of discrete values.

Declaration Syntax
public Tuple<Quantity, Quantity> MinMaxDiscreteValues { get; }

Name
Gets the variable's name.

Declaration Syntax
public string Name { get; }

QuantityName
Gets the name of the quantity represented by this variable.

Declaration Syntax
public string QuantityName { get; }

Range
Gets the domain of validity for variable's value.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 127
Ansys.ACT.Mechanical.Fields Namespace

Declaration Syntax
public Range Range { get; }

Unit
Gets the symbol of the unit used to express this variable's values.

Declaration Syntax
public string Unit { get; }

GetDiscreteValue(int)
Changes a value at a given position in the tabular definition of the variable.

Declaration Syntax
public Quantity GetDiscreteValue(int index)

Parameters
index(int)

Index of the value to change.

SetDiscreteValue(int, Quantity)
Changes a value at a given position in the tabular definition of the variable.

Declaration Syntax
public void SetDiscreteValue(int index, Quantity value)

Parameters
index(int)

Index of the value to change.

value(Quantity)

New value.

VariableDefinitionType
Defines the various ways to define the values of a variable.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
128 of ANSYS, Inc. and its subsidiaries and affiliates.
VariableDefinitionType

Declaration Syntax
public enum VariableDefinitionType

Table 81: Members

Member Discrete The variable is defined with a set of discrete values.


Member Formula The variable is defined with an expression that can involve other
variables.
Member Free The variable represents a free DOF.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 129
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
130 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Fields.Adapters Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Fields.Adapters

Table 82: Members

FieldAdapter (p. 131) Base class for objects that handle the interface between the generic
boundary condition wrapper and the various types of concrete object
implemented in Mechanical.
FieldAdapterManager (p. 134) Static class that operates like a factory to create field adapters from
Mechanical objects.

FieldAdapter
Base class for objects that handle the interface between the generic boundary condition wrapper and
the various types of concrete object implemented in Mechanical.

Declaration Syntax
public abstract class FieldAdapter

Table 83: Members

Constructor FieldAdapter(IDSBCInformation) (p. 131) No details are provided for this entry.
Property FieldProvider (p. 132) Gets the wrapped object from Mechanical.
Method ChangeFieldDefinitionType(AnsBCLVType, Changes the definition type for a field of the
kEDDataType) (p. 132) wrapped object from Mechanical.
NestedType IDefinition (p. 132) Interface implemented by objects that specify
a type of adapter for a given field provider
object from Mechanical.
NestedType Keywords (p. 133) Helper static class that translates a
component definition type into the magic
string to provide to Mechanical object's
property to make it switch to the desired
definition.

FieldAdapter(IDSBCInformation)
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 131
Ansys.ACT.Mechanical.Fields.Adapters Namespace

Declaration Syntax
protected FieldAdapter(IDSBCInformation fieldProvider)

Parameters
fieldProvider(IDSBCInformation)

No details are provided for this entry.

FieldProvider
Gets the wrapped object from Mechanical.

Declaration Syntax
public IDSBCInformation FieldProvider { get; }

ChangeFieldDefinitionType(AnsBCLVType, kEDDataType)
Changes the definition type for a field of the wrapped object from Mechanical.

Declaration Syntax
public virtual abstract void ChangeFieldDefinitionType(AnsBCLVType fieldType, kEDDataType newType)

Parameters
fieldType(AnsBCLVType)

Value that identifies the component of the wrapped object to change.

newType(kEDDataType)

Value that corresponds to the new way to use for defining the component's values.

IDefinition
Interface implemented by objects that specify a type of adapter for a given field provider object from
Mechanical.

Declaration Syntax
public interface IDefinition

Table 84: Members

Method Adapt(IDSBCInformation) (p. 133) Creates an adapter for a given load object from
Mechanical.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
132 of ANSYS, Inc. and its subsidiaries and affiliates.
FieldAdapter

Adapt(IDSBCInformation)
Creates an adapter for a given load object from Mechanical.

Declaration Syntax
public FieldAdapter Adapt(IDSBCInformation load)

Parameters
load(IDSBCInformation)

Load to adapt.

Keywords
Helper static class that translates a component definition type into the magic string to provide to
Mechanical object's property to make it switch to the desired definition.

Declaration Syntax
public static class Keywords

Table 85: Members

Field Constant (p. 133) No details are provided for this


entry.
Field ConstantRamped (p. 133) No details are provided for this
entry.
Field Free (p. 134) No details are provided for this
entry.
Field Function (p. 134) No details are provided for this
entry.
Field Table (p. 134) No details are provided for this
entry.
Method Get(kEDDataType) (p. 134) No details are provided for this
entry.

Constant
No details are provided for this entry.

Declaration Syntax
public static readonly string Constant

ConstantRamped
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 133
Ansys.ACT.Mechanical.Fields.Adapters Namespace

Declaration Syntax
public static readonly string ConstantRamped

Free
No details are provided for this entry.

Declaration Syntax
public static readonly string Free

Function
No details are provided for this entry.

Declaration Syntax
public static readonly string Function

Table
No details are provided for this entry.

Declaration Syntax
public static readonly string Table

Get(kEDDataType)
No details are provided for this entry.

Declaration Syntax
public static string Get(kEDDataType type)

Parameters
type(kEDDataType)

No details are provided for this entry.

FieldAdapterManager
Static class that operates like a factory to create field adapters from Mechanical objects.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
134 of ANSYS, Inc. and its subsidiaries and affiliates.
FieldAdapterManager

Declaration Syntax
public static class FieldAdapterManager

Table 86: Members

Property AdapterDefinitions (p. 135) Gets the collection of adapters in this manager.
Method RegisterNewAdapter(IDefinition) (p. 135) Register the instance object that defines a type of
field adapter.
Method UnregisterAdapter(int) (p. 135) Removes the instance object that defines a type
of field adapter from this manager.

AdapterDefinitions
Gets the collection of adapters in this manager.

Declaration Syntax
public static IList<IDefinition> AdapterDefinitions { get; }

RegisterNewAdapter(IDefinition)
Register the instance object that defines a type of field adapter.

Declaration Syntax
public static void RegisterNewAdapter(IDefinition definition)

Parameters
definition(IDefinition)

Load adapter definition to register.

UnregisterAdapter(int)
Removes the instance object that defines a type of field adapter from this manager.

Declaration Syntax
public static void UnregisterAdapter(int index)

Parameters
index(int)

Index of the adapter to remove within the collection of adapters of this manager.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 135
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
136 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Utilities Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Utilities

Table 87: Members

GeometryImportPreferences (p. 137) This is used to provide import and reload (refresh) preferences
for geometry file import. These preferences are identical to those
exposed in the WB2 project schematic and Mechanical Geometry
preferences. More information can be found in the “Geometry
Preferences” section of the “CAD Integration” documentation.
Both general and advanced preferences are provided.

Default values will be taken from the Mechanical preferences.


This allows user-specified default values to propagate to these
preferences.

GeometryImportPreferences
This is used to provide import and reload (refresh) preferences for geometry file import. These preferences
are identical to those exposed in the WB2 project schematic and Mechanical Geometry preferences.
More information can be found in the “Geometry Preferences” section of the “CAD Integration” docu-
mentation. Both general and advanced preferences are provided.

Default values will be taken from the Mechanical preferences. This allows user-specified default values
to propagate to these preferences.

Declaration Syntax
public class GeometryImportPreferences

Table 88: Members

Property AnalysisType (p. 139) Specify the analysis type to target during import.
Property AttributeKey (p. 139) If `ProcessAttributes` is `true`, import only those
attributes with this prefix. Multiple
semicolon-delimited filters may be specified. An
empty string matches everything.
Property CADAssociativity (p. 139) Allow associativity.
Property Clean (p. 139) Clean unwanted features when importing geometry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 137
Ansys.ACT.Mechanical.Utilities Namespace

Property ComparePartsOnUpdate (p. 139) Enable mesh preservation on refresh for unmodified
entities.
Property ComparePartsTolerance (p. 139) Specifies the tolerance to use when comparing parts.
Property CoordinateSystemKey (p. 140) If `ProcessCoordinateSystems` is `true`, import only
those coordinate systems with this prefix. Multiple
semicolon-delimited filters may be specified. An
empty string matches everything.
Property DecomposeDisjointGeometry (p. 140) Enable the decomposition of disjoint geometries for
the following associative geometry interfaces:

Creo Parametric (faces only)


Autodesk Inventor (bodies only)
Property DoSmartUpdate (p. 140) Speed up refreshes for models with unmodified
components. Causes changes to other import
preferences to be ignored during refresh.
Property EnclosureSymmetryProcessing (p. 140) Enable the processing of enclosure and symmetry
named selections.
Property FacetQuality (p. 140) Specifies what facet quality should be used for the
import. The default value is Source meaning that the
facets as represented in the CAD system or use a
Normal option for those that do not have display.
The others are relative settings compared to "normal"
facet quality. Typically, better facet quality requires
more memory and may take additional time to
import/update.
Property MixedImportResolution (p. 141) Allows mixed-dimension parts to be imported as
assembly components with parts of different
dimensions.
Property NamedSelectionKey (p. 141) If `ProcessNamedSelections` is `true`, import only
those named selections with this prefix. Multiple
semicolon-delimited filters may be specified.
Property ProcessAttributes (p. 141) Import CAD system attributes.
Property ProcessCoordinateSystems (p. 141) Import coordinate systems defined in the CAD source.
Property ProcessInstances (p. 141) Honor part instance specifications.
Property ProcessLines (p. 141) Import lines bodies.
Property ProcessMaterialProperties (p. 142) Import primary material data defined in the CAD
source.
Property ProcessNamedSelections (p. 142) Import/create named selections.
Property ProcessSolids (p. 142) Import solid bodies.
Property ProcessSurfaces (p. 142) Import surface bodies.
Property ProcessWorkPoints (p. 142) Import work points.
Property ReaderSaveFile (p. 142) Save the part file of a model after the import.
Property StitchTolerance (p. 143) If `StitchType` is `User`, specifies the tolerance to use
for stitching detection.
Property StitchType (p. 143) Specifies how surfaces should be stitched together.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
138 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportPreferences

AnalysisType
Specify the analysis type to target during import.

Declaration Syntax
public AnalysisType AnalysisType { set;get; }

AttributeKey
If `ProcessAttributes` is `true`, import only those attributes with this prefix. Multiple semicolon-delimited
filters may be specified. An empty string matches everything.

Declaration Syntax
public string AttributeKey { set;get; }

CADAssociativity
Allow associativity.

Declaration Syntax
public bool CADAssociativity { set;get; }

Clean
Clean unwanted features when importing geometry.

Declaration Syntax
public bool Clean { set;get; }

ComparePartsOnUpdate
Enable mesh preservation on refresh for unmodified entities.

Declaration Syntax
public ComparePartsOnUpdate ComparePartsOnUpdate { set;get; }

ComparePartsTolerance
Specifies the tolerance to use when comparing parts.

Declaration Syntax
public ComparePartsTolerance ComparePartsTolerance { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 139
Ansys.ACT.Mechanical.Utilities Namespace

CoordinateSystemKey
If `ProcessCoordinateSystems` is `true`, import only those coordinate systems with this prefix. Multiple
semicolon-delimited filters may be specified. An empty string matches everything.

Declaration Syntax
public string CoordinateSystemKey { set;get; }

DecomposeDisjointGeometry
Enable the decomposition of disjoint geometries for the following associative geometry interfaces:

Creo Parametric (faces only)


Autodesk Inventor (bodies only)

Declaration Syntax
public bool DecomposeDisjointGeometry { set;get; }

DoSmartUpdate
Speed up refreshes for models with unmodified components. Causes changes to other import prefer-
ences to be ignored during refresh.

Declaration Syntax
public bool DoSmartUpdate { set;get; }

EnclosureSymmetryProcessing
Enable the processing of enclosure and symmetry named selections.

Declaration Syntax
public bool EnclosureSymmetryProcessing { set;get; }

FacetQuality
Specifies what facet quality should be used for the import. The default value is Source meaning that
the facets as represented in the CAD system or use a Normal option for those that do not have display.
The others are relative settings compared to "normal" facet quality. Typically, better facet quality re-
quires more memory and may take additional time to import/update.

Declaration Syntax
public FacetQuality FacetQuality { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
140 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportPreferences

MixedImportResolution
Allows mixed-dimension parts to be imported as assembly components with parts of different dimen-
sions.

Declaration Syntax
public MixedImportResolution MixedImportResolution { set;get; }

NamedSelectionKey
If `ProcessNamedSelections` is `true`, import only those named selections with this prefix. Multiple
semicolon-delimited filters may be specified.

Declaration Syntax
public string NamedSelectionKey { set;get; }

ProcessAttributes
Import CAD system attributes.

Declaration Syntax
public bool ProcessAttributes { set;get; }

ProcessCoordinateSystems
Import coordinate systems defined in the CAD source.

Declaration Syntax
public bool ProcessCoordinateSystems { set;get; }

ProcessInstances
Honor part instance specifications.

Declaration Syntax
public bool ProcessInstances { set;get; }

ProcessLines
Import lines bodies.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 141
Ansys.ACT.Mechanical.Utilities Namespace

Declaration Syntax
public bool ProcessLines { set;get; }

ProcessMaterialProperties
Import primary material data defined in the CAD source.

Declaration Syntax
public bool ProcessMaterialProperties { set;get; }

ProcessNamedSelections
Import/create named selections.

Declaration Syntax
public bool ProcessNamedSelections { set;get; }

ProcessSolids
Import solid bodies.

Declaration Syntax
public bool ProcessSolids { set;get; }

ProcessSurfaces
Import surface bodies.

Declaration Syntax
public bool ProcessSurfaces { set;get; }

ProcessWorkPoints
Import work points.

Declaration Syntax
public bool ProcessWorkPoints { set;get; }

ReaderSaveFile
Save the part file of a model after the import.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
142 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportPreferences

Declaration Syntax
public bool ReaderSaveFile { set;get; }

StitchTolerance
If `StitchType` is `User`, specifies the tolerance to use for stitching detection.

Declaration Syntax
public double StitchTolerance { set;get; }

StitchType
Specifies how surfaces should be stitched together.

Declaration Syntax
public StitchSurfacesOnImport StitchType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 143
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
144 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Application.SolveProcessSettings
Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Application.SolveProcessSettings

Table 89: Members

ILinuxSettings (p. 145) No details are provided for this entry.


IQueueSettings (p. 146) No details are provided for this entry.
ISolveConfiguration (p. 148) No details are provided for this entry.
ISolveProcessSettings (p. 149) No details are provided for this entry.
ISolverMemorySettings (p. 152) No details are provided for this entry.
LinuxSettings (p. 153) The class representing the linux settings portion of the solve process
settings.
QueueSettings (p. 154) The class representing queue settings.
RSMQueue (p. 155) The class representing an RSM Queue.
SolveConfiguration (p. 156) The class representing a solve configuration.
SolveProcessSettings (p. 158) The class representing solve process settings.
SolverMemorySettings (p. 162) The class representing the solver memory settings portion of the
solve process settings.

ILinuxSettings
No details are provided for this entry.

Declaration Syntax
public interface ILinuxSettings

Table 90: Members

Property Active (p. 146) Gets or sets whether or not manual linux settings are enable for
the configuration.
Property UserName (p. 146) Gets or sets the user name field for the manual linux settings.
Property WorkingFolder (p. 146) Gets or sets the working folder field for the manual linxus settings.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 145
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Active
Gets or sets whether or not manual linux settings are enable for the configuration.

Declaration Syntax
public bool Active { set;get; }

UserName
Gets or sets the user name field for the manual linux settings.

Declaration Syntax
public string UserName { set;get; }

WorkingFolder
Gets or sets the working folder field for the manual linxus settings.

Declaration Syntax
public string WorkingFolder { set;get; }

IQueueSettings
No details are provided for this entry.

Declaration Syntax
public interface IQueueSettings

Table 91: Members

Property DCSPassword (p. 146) No details are provided for this entry.
Property DCSUrl (p. 147) No details are provided for this entry.
Property DCSUsername (p. 147) No details are provided for this entry.
Property JobName (p. 147) Gets or sets the Job Name field for the queue settings.
Property License (p. 147) Gets or sets the License field for the queue settings.
Property Name (p. 147) Gets or sets the name of the current queue for the
configuration.
Property SolutionExecutionTarget (p. 147) No details are provided for this entry.

DCSPassword
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
146 of ANSYS, Inc. and its subsidiaries and affiliates.
IQueueSettings

Declaration Syntax
public string DCSPassword { set;get; }

DCSUrl
No details are provided for this entry.

Declaration Syntax
public string DCSUrl { set;get; }

DCSUsername
No details are provided for this entry.

Declaration Syntax
public string DCSUsername { set;get; }

JobName
Gets or sets the Job Name field for the queue settings.

Declaration Syntax
public string JobName { set;get; }

License
Gets or sets the License field for the queue settings.

Declaration Syntax
public string License { set;get; }

Name
Gets or sets the name of the current queue for the configuration.

Declaration Syntax
public string Name { set;get; }

SolutionExecutionTarget
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 147
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Declaration Syntax
public string SolutionExecutionTarget { set;get; }

ISolveConfiguration
No details are provided for this entry.

Declaration Syntax
public interface ISolveConfiguration

Table 92: Members

Property Default (p. 148) Gets whether or not this SolveConfiguration is the default
configuration.
Property Name (p. 148) Gets or sets the name of the SolveConfiguraiton Object
Property Settings (p. 148) Gets the QueueSettings object for the configuration.
Property SolveProcessSettings (p. 149) Gets the SolveProcessSettings for the current object.
Method SetAsDefault() (p. 149) Sets 'this' to be the default configuration to solve with.

Default
Gets whether or not this SolveConfiguration is the default configuration.

Declaration Syntax
public bool Default { get; }

Name
Gets or sets the name of the SolveConfiguraiton Object

Declaration Syntax
public string Name { set;get; }

Settings
Gets the QueueSettings object for the configuration.

Declaration Syntax
public IQueueSettings Settings { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
148 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolveProcessSettings

SolveProcessSettings
Gets the SolveProcessSettings for the current object.

Declaration Syntax
public ISolveProcessSettings SolveProcessSettings { get; }

SetAsDefault()
Sets 'this' to be the default configuration to solve with.

Declaration Syntax
public void SetAsDefault()

ISolveProcessSettings
No details are provided for this entry.

Declaration Syntax
public interface ISolveProcessSettings

Table 93: Members

Property AdditionalCommandLineArguments (p. 150) Gets or sets the "Additional Command Line
Arguments" field.
Property CustomExecutablePath (p. 150) Gets or sets the "Custom Executable Name
(with path)" field.
Property DCSAutoDownloadResults (p. 150) Gets or sets the "DCS Auto Download Results"
field.
Property DistributeSolution (p. 150) Gets or sets the boolean "Distribute Solution
(if possible)" field.
Property GPUAccelerationDevice (p. 150) Gets or sets the "GPU Acceleration Device" field.
Property HybridParallel (p. 151) Gets or sets the boolean "Hybrid Parallel
(Mechanical APDL)" field.
Property LicenseQueuing (p. 151) Gets or sets the "License Queuing: Wait for
Available License" field.
Property ManualLinuxSettings (p. 151) Gets the LinuxSettings object for the
configuration.
Property ManualSolverMemorySettings (p. 151) Gets the SolverMemorySettings object for the
configuration.
Property MaxNumberOfCores (p. 151) Gets or sets the "Maximum number of utilized
cores" field.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 149
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Property NumberOfGPUDevices (p. 151) Gets or sets the "Number of utilized GPU
devices" field.
Property NumberOfProcesses (p. 152) Gets or sets the "Number of processes" field.
Property SolveInSynchronousMode (p. 152) Gets or sets the "Solve in synchronous mode"
field.
Property ThreadsPerProcess (p. 152) Gets or sets the "Threads per process" field.
Property UserString (p. 152) Gets or sets the User String field.
Property UseSharedLicense (p. 152) Gets or sets the "Use Shared License, if possible"
field.

AdditionalCommandLineArguments
Gets or sets the "Additional Command Line Arguments" field.

Declaration Syntax
public string AdditionalCommandLineArguments { set;get; }

CustomExecutablePath
Gets or sets the "Custom Executable Name (with path)" field.

Declaration Syntax
public string CustomExecutablePath { set;get; }

DCSAutoDownloadResults
Gets or sets the "DCS Auto Download Results" field.

Declaration Syntax
public bool DCSAutoDownloadResults { set;get; }

DistributeSolution
Gets or sets the boolean "Distribute Solution (if possible)" field.

Declaration Syntax
public bool DistributeSolution { set;get; }

GPUAccelerationDevice
Gets or sets the "GPU Acceleration Device" field.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
150 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolveProcessSettings

Declaration Syntax
public GPUAccelerationDevicesType GPUAccelerationDevice { set;get; }

HybridParallel
Gets or sets the boolean "Hybrid Parallel (Mechanical APDL)" field.

Declaration Syntax
public bool HybridParallel { set;get; }

LicenseQueuing
Gets or sets the "License Queuing: Wait for Available License" field.

Declaration Syntax
public bool LicenseQueuing { set;get; }

ManualLinuxSettings
Gets the LinuxSettings object for the configuration.

Declaration Syntax
public ILinuxSettings ManualLinuxSettings { get; }

ManualSolverMemorySettings
Gets the SolverMemorySettings object for the configuration.

Declaration Syntax
public ISolverMemorySettings ManualSolverMemorySettings { get; }

MaxNumberOfCores
Gets or sets the "Maximum number of utilized cores" field.

Declaration Syntax
public int MaxNumberOfCores { set;get; }

NumberOfGPUDevices
Gets or sets the "Number of utilized GPU devices" field.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 151
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Declaration Syntax
public int NumberOfGPUDevices { set;get; }

NumberOfProcesses
Gets or sets the "Number of processes" field.

Declaration Syntax
public int NumberOfProcesses { get; }

SolveInSynchronousMode
Gets or sets the "Solve in synchronous mode" field.

Declaration Syntax
public bool SolveInSynchronousMode { set;get; }

ThreadsPerProcess
Gets or sets the "Threads per process" field.

Declaration Syntax
public int ThreadsPerProcess { set;get; }

UserString
Gets or sets the User String field.

Declaration Syntax
public string UserString { set;get; }

UseSharedLicense
Gets or sets the "Use Shared License, if possible" field.

Declaration Syntax
public bool UseSharedLicense { set;get; }

ISolverMemorySettings
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
152 of ANSYS, Inc. and its subsidiaries and affiliates.
LinuxSettings

Declaration Syntax
public interface ISolverMemorySettings

Table 94: Members

Property Active (p. 153) Gets or sets whether or not manual memory settings are active in the
current configuration.
Property Database (p. 153) Gets or sets the database memory amount (MB).
Property Workspace (p. 153) Gets or sets the workspace memory amount (megabytes).

Active
Gets or sets whether or not manual memory settings are active in the current configuration.

Declaration Syntax
public bool Active { set;get; }

Database
Gets or sets the database memory amount (MB).

Declaration Syntax
public int Database { set;get; }

Workspace
Gets or sets the workspace memory amount (megabytes).

Declaration Syntax
public int Workspace { set;get; }

LinuxSettings
The class representing the linux settings portion of the solve process settings.

Declaration Syntax
public class LinuxSettings : ILinuxSettings

Table 95: Members

Constructor LinuxSettings() (p. 154) Creates a LinuxSettings object


Property Active (p. 154) Whether the linux settings are
active.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 153
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Property UserName (p. 154) The user name.


Property WorkingFolder (p. 154) The working folder.

LinuxSettings()
Creates a LinuxSettings object

Declaration Syntax
public LinuxSettings()

Active
Whether the linux settings are active.

Declaration Syntax
public bool Active { set;get; }

UserName
The user name.

Declaration Syntax
public string UserName { set;get; }

WorkingFolder
The working folder.

Declaration Syntax
public string WorkingFolder { set;get; }

QueueSettings
The class representing queue settings.

Declaration Syntax
public class QueueSettings : IQueueSettings

Table 96: Members

Constructor QueueSettings() (p. 155) Creates a QueueSettings object


Property JobName (p. 155) The job name of the queue settings.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
154 of ANSYS, Inc. and its subsidiaries and affiliates.
RSMQueue

Property License (p. 155) The license of the queue settings. The setter will throw an
exception if the given license is not valid.
Property Name (p. 155) The name of the queue settings.

QueueSettings()
Creates a QueueSettings object

Declaration Syntax
public QueueSettings()

JobName
The job name of the queue settings.

Declaration Syntax
public string JobName { set;get; }

License
The license of the queue settings. The setter will throw an exception if the given license is not valid.

Declaration Syntax
public string License { set;get; }

Name
The name of the queue settings.

Declaration Syntax
public string Name { set;get; }

RSMQueue
The class representing an RSM Queue.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 155
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Declaration Syntax
public class RSMQueue

Table 97: Members

Property HPCConfiguration (p. 156) The HPC configuration of the RSM


Queue.
Property HPCQueue (p. 156) The HPC Queue of the RSM Queue.
Property HPCType (p. 156) The HPC type of the RSM Queue
Property Name (p. 156) The name of the RSM Queue.

HPCConfiguration
The HPC configuration of the RSM Queue.

Declaration Syntax
public string HPCConfiguration { get; }

HPCQueue
The HPC Queue of the RSM Queue.

Declaration Syntax
public string HPCQueue { get; }

HPCType
The HPC type of the RSM Queue

Declaration Syntax
public string HPCType { get; }

Name
The name of the RSM Queue.

Declaration Syntax
public string Name { get; }

SolveConfiguration
The class representing a solve configuration.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
156 of ANSYS, Inc. and its subsidiaries and affiliates.
SolveConfiguration

Declaration Syntax
public class SolveConfiguration : ISolveConfiguration, IEquatable<SolveConfiguration>

Table 98: Members

Constructor SolveConfiguration() (p. 157) Creates a SolveConfiguration object


Constructor SolveConfiguration(string) (p. 157) Creates a SolveConfiguration object with a given name
or gets the instance of an existing SolveConfiguration
with that name.
Property Default (p. 157) Whether this solve configuration is the default.
Property Name (p. 158) The name of the solve configuration.
Property Settings (p. 158) Returns the queue settings of this solve configuration.
Property SolveProcessSettings (p. 158) Returns the solve process settings of this solve
configuration.
Method SetAsDefault() (p. 158) Sets this solve configuration as the default.

SolveConfiguration()
Creates a SolveConfiguration object

Declaration Syntax
public SolveConfiguration()

SolveConfiguration(string)
Creates a SolveConfiguration object with a given name or gets the instance of an existing SolveCon-
figuration with that name.

Declaration Syntax
public SolveConfiguration(string name)

Parameters
name(string)

No details are provided for this entry.

Default
Whether this solve configuration is the default.

Declaration Syntax
public bool Default { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 157
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Name
The name of the solve configuration.

Declaration Syntax
public string Name { set;get; }

Settings
Returns the queue settings of this solve configuration.

Declaration Syntax
public QueueSettings Settings { get; }

SolveProcessSettings
Returns the solve process settings of this solve configuration.

Declaration Syntax
public SolveProcessSettings SolveProcessSettings { get; }

SetAsDefault()
Sets this solve configuration as the default.

Declaration Syntax
public virtual void SetAsDefault()

SolveProcessSettings
The class representing solve process settings.

Declaration Syntax
public class SolveProcessSettings : ISolveProcessSettings

Table 99: Members

Constructor SolveProcessSettings() (p. 159) Creates a SolveProcessSettings object


Property AdditionalCommandLineArguments (p. 159) Any additional command line arguments to
give to the solver.
Property CustomExecutablePath (p. 159) The custom executable path for user
programmable features in the solver.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
158 of ANSYS, Inc. and its subsidiaries and affiliates.
SolveProcessSettings

Property DCSAutoDownloadResults (p. 160) Whether results need to be automatically


downloaded for DCS job after completion.
Property DistributeSolution (p. 160) Whether to run the solution in distributed
mode.
Property GPUAccelerationDevice (p. 160) The GPU Acceleration device the solver will
use.
Property HybridParallel (p. 160) Whether to run the solution in hybrid
parallel.
Property LicenseQueuing (p. 160) Whether license queueing is active.
Property ManualLinuxSettings (p. 160) Returns the manual linux settings.
Property ManualSolverMemorySettings (p. 161) Returns the manual solver memory settings.
Property MaxNumberOfCores (p. 161) The maximum number of cores the solver
will use.
Property NumberOfGPUDevices (p. 161) The number of GPU devices.
Property NumberOfProcesses (p. 161) The number of processes the solver will use.
Property SolveInSynchronousMode (p. 161) Whether the solve will be in synchronous
mode.
Property ThreadsPerProcess (p. 161) The threads per process the solver will use.
Property UseSharedLicense (p. 162) Whether the solver will use a shared license.

SolveProcessSettings()
Creates a SolveProcessSettings object

Declaration Syntax
public SolveProcessSettings()

AdditionalCommandLineArguments
Any additional command line arguments to give to the solver.

Declaration Syntax
public string AdditionalCommandLineArguments { set;get; }

CustomExecutablePath
The custom executable path for user programmable features in the solver.

Declaration Syntax
public string CustomExecutablePath { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 159
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

DCSAutoDownloadResults
Whether results need to be automatically downloaded for DCS job after completion.

Declaration Syntax
public bool DCSAutoDownloadResults { set;get; }

DistributeSolution
Whether to run the solution in distributed mode.

Declaration Syntax
public bool DistributeSolution { set;get; }

GPUAccelerationDevice
The GPU Acceleration device the solver will use.

Declaration Syntax
public GPUAccelerationDevicesType GPUAccelerationDevice { set;get; }

HybridParallel
Whether to run the solution in hybrid parallel.

Declaration Syntax
public bool HybridParallel { set;get; }

LicenseQueuing
Whether license queueing is active.

Declaration Syntax
public bool LicenseQueuing { set;get; }

ManualLinuxSettings
Returns the manual linux settings.

Declaration Syntax
public LinuxSettings ManualLinuxSettings { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
160 of ANSYS, Inc. and its subsidiaries and affiliates.
SolveProcessSettings

ManualSolverMemorySettings
Returns the manual solver memory settings.

Declaration Syntax
public SolverMemorySettings ManualSolverMemorySettings { get; }

MaxNumberOfCores
The maximum number of cores the solver will use.

Declaration Syntax
public int MaxNumberOfCores { set;get; }

NumberOfGPUDevices
The number of GPU devices.

Declaration Syntax
public int NumberOfGPUDevices { set;get; }

NumberOfProcesses
The number of processes the solver will use.

Declaration Syntax
public int NumberOfProcesses { get; }

SolveInSynchronousMode
Whether the solve will be in synchronous mode.

Declaration Syntax
public bool SolveInSynchronousMode { set;get; }

ThreadsPerProcess
The threads per process the solver will use.

Declaration Syntax
public int ThreadsPerProcess { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 161
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

UseSharedLicense
Whether the solver will use a shared license.

Declaration Syntax
public bool UseSharedLicense { set;get; }

SolverMemorySettings
The class representing the solver memory settings portion of the solve process settings.

Declaration Syntax
public class SolverMemorySettings : ISolverMemorySettings

Table 100: Members

Constructor SolverMemorySettings() (p. 162) Creates a SolverMemorySettings object


Property Active (p. 162) Whether the solver memory settings are
active.
Property Database (p. 162) Database size.
Property Workspace (p. 163) Workspace size.

SolverMemorySettings()
Creates a SolverMemorySettings object

Declaration Syntax
public SolverMemorySettings()

Active
Whether the solver memory settings are active.

Declaration Syntax
public bool Active { set;get; }

Database
Database size.

Declaration Syntax
public int Database { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
162 of ANSYS, Inc. and its subsidiaries and affiliates.
SolverMemorySettings

Workspace
Workspace size.

Declaration Syntax
public int Workspace { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 163
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
164 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.AdditionalProperties
Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.AdditionalProperties

Table 101: Members

ApplyCancelProperty (p. 165) Provides a way to create properties with Apply/Cancel buttons.
Control (p. 165) The control type for an additional property.
DoubleProperty (p. 166) Provides a way to create properties that can hold double type values.
ExpressionProperty (p. 166) Provides a way to create properties that can hold expressions.
OptionsProperty (p. 166) Provides a way to create properties that show up as a drop down in
the UI.

ApplyCancelProperty
Provides a way to create properties with Apply/Cancel buttons.

Declaration Syntax
public class ApplyCancelProperty : CustomProperty

Table 102: Members

Field OnApply (p. 165) The event that will be raised when the Apply button is clicked with the
property.

OnApply
The event that will be raised when the Apply button is clicked with the property.

Declaration Syntax
public Action<CustomProperty> OnApply

Control
The control type for an additional property.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 165
Ansys.ACT.Mechanical.AdditionalProperties Namespace

Declaration Syntax
public enum Control

Table 103: Members

Member ApplyCancel Property control for Apply and Cancel


buttons.
Member Double Property control for doubles.
Member Expression Property control for strings.
Member Options Property control for dropdown options.

DoubleProperty
Provides a way to create properties that can hold double type values.

Declaration Syntax
public class DoubleProperty : CustomProperty, IParameterizable

Table 104: Members

Property ValidRange (p. 166) Tuple that can be used to control the upper and lower bounds of a
double property.

ValidRange
Tuple that can be used to control the upper and lower bounds of a double property.

Declaration Syntax
public PythonTuple ValidRange { set;get; }

ExpressionProperty
Provides a way to create properties that can hold expressions.

Declaration Syntax
public class ExpressionProperty : CustomProperty

OptionsProperty
Provides a way to create properties that show up as a drop down in the UI.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
166 of ANSYS, Inc. and its subsidiaries and affiliates.
OptionsProperty

Declaration Syntax
public class OptionsProperty : CustomProperty

Table 105: Members

Field GetOptionsCallback (p. 167) Use this callback to dynamically add options to the options
dictionary.
Property Options (p. 167) Options shown in the drop-down, represented by a dictionary
of int -> string. Where the int represents the option, and string
represents string shown in the UI. When an option is selected
the Value property of the property is set to to the option int.

GetOptionsCallback
Use this callback to dynamically add options to the options dictionary.

Declaration Syntax
public Func<CustomProperty, IDictionary<object, object>> GetOptionsCallback

Options
Options shown in the drop-down, represented by a dictionary of int -> string. Where the int represents
the option, and string represents string shown in the UI. When an option is selected the Value property
of the property is set to to the option int.

Declaration Syntax
public IDictionary<object, object> Options { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 167
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
168 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.DesignModeler

Table 106: Members

IDesignModelerDataModel (p. 170) Defines the DesignModeler data model.


IDesignModelerExtAPI (p. 171) Defines the main entry point of all APIs.
IDesignModelerGeoData (p. 172) Defines the DesignModeler geometry data model.
IDesignModelerGeoFeature (p. 172) Defines a DesignModeler custom feature.
IDesignModelerSelectionInfo (p. 173) Defines the DesignModeler selection information.
IExtrude (p. 174) Defines an "Extrude" operation.
IGeometryBuilder (p. 175) Defines the geometry builder.
IIntersect (p. 176) Defines an "Intersect" operation.
IOperations (p. 176) Defines a list of available geometry operations.
IOperationTools (p. 179) Defines a list of tools to manipulate the geometry.
IPrimitives (p. 184) Defines the list of creatable primitives.
IPSGeoBody (p. 184) Defines a body.
IPSGeoEdge (p. 185) Defines an edge.
IPSGeoEntity (p. 185) Defines a generic geometry entity.
IPSGeoFace (p. 185) Defines a face.
IPSGeoPart (p. 185) Defines a part.
IQueries (p. 185) Defines a list of available queries on the geometry.
IRevolve (p. 187) Defines a "Revolve" operation.
ISheetCone (p. 189) Defines a sheet cone primitive.
ISheetCylinder (p. 190) Defines a sheet cylinder primitive.
ISheetPolygon (p. 191) Defines a sheet polygon primitive.
ISheets (p. 191) Defines the list all creatable sheet geometry
primitives.
ISheetSphere (p. 192) Defines a sheet sphere primitive.
ISolidBox (p. 193) Defines a solid box primitive.
ISolidCone (p. 193) Defines a solid cone primitive.
ISolidCylinder (p. 195) Defines a solid cylinder primitive.
ISolids (p. 195) Defines the list of all creatable solid geometry
primitives.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 169
Ansys.ACT.Interfaces.DesignModeler Namespace

ISolidSphere (p. 198) Defines a solid sphere primitive.


ISubtract (p. 198) Defines a "Subtract" operation.
IUnion (p. 199) Defines an "Union" operation.
IWireArc (p. 199) Defines a wire arc primitive.
IWireBCurve (p. 201) Defines awire b-curve primitive.
IWireEllipse (p. 201) Defines a wire ellipse primitive.
IWirePolyline (p. 203) Defines a wire polyline primitive.
IWires (p. 203) Defines the list of all creatable wire geometry
primitives.

IDesignModelerDataModel
Defines the DesignModeler data model.

Declaration Syntax
public interface IDesignModelerDataModel

Table 107: Members

Property Components (p. 170) Gets all components (named selections).


Property GeoData (p. 170) Gets the geometry data model object.
Property GeometryBuilder (p. 171) Gets the geometry builder object.
Property Queries (p. 171) Gets the queries object.
Method ComponentById(int) (p. 171) Returns the component (named selection)
associated to the specified identifier.
Method CurrentUnitFromQuantityName(string) (p. 171) Returns the current unit assocaited to a
quantity name.

Components
Gets all components (named selections).

Declaration Syntax
public IList<ISelectionInfo> Components { get; }

GeoData
Gets the geometry data model object.

Declaration Syntax
public IDesignModelerGeoData GeoData { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
170 of ANSYS, Inc. and its subsidiaries and affiliates.
IDesignModelerExtAPI

GeometryBuilder
Gets the geometry builder object.

Declaration Syntax
public IGeometryBuilder GeometryBuilder { get; }

Queries
Gets the queries object.

Declaration Syntax
public IQueries Queries { get; }

ComponentById(int)
Returns the component (named selection) associated to the specified identifier.

Declaration Syntax
public ISelectionInfo ComponentById(int id)

Parameters
id(int)

Id of the component.

CurrentUnitFromQuantityName(string)
Returns the current unit assocaited to a quantity name.

Declaration Syntax
public string CurrentUnitFromQuantityName(string quantityName)

Parameters
quantityName(string)

The quantity name.

IDesignModelerExtAPI
Defines the main entry point of all APIs.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 171
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IDesignModelerExtAPI

IDesignModelerGeoData
Defines the DesignModeler geometry data model.

Declaration Syntax
public interface IDesignModelerGeoData

Table 108: Members

Property Bodies (p. 172) Gets all


bodies.
Property Parts (p. 172) Gets all
parts.

Bodies
Gets all bodies.

Declaration Syntax
public IList<IPSGeoBody> Bodies { get; }

Parts
Gets all parts.

Declaration Syntax
public IList<IBaseGeoPart> Parts { get; }

IDesignModelerGeoFeature
Defines a DesignModeler custom feature.

Declaration Syntax
public interface IDesignModelerGeoFeature

Table 109: Members

Property Bodies (p. 173) Gets or sets the list of bodies or


parts generated by the feature.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
172 of ANSYS, Inc. and its subsidiaries and affiliates.
IDesignModelerSelectionInfo

Property MaterialType (p. 173) Gets or sets the material type used
to generate the feature.
Method AddProblematicGeometry(IEnumerable<IPSGeoEntity>, Add a list of geometry entities has
string) (p. 173) problemetic geometries.

Bodies
Gets or sets the list of bodies or parts generated by the feature.

Declaration Syntax
public IEnumerable<IBaseGeoBodyOrPart> Bodies { set;get; }

MaterialType
Gets or sets the material type used to generate the feature.

Declaration Syntax
public MaterialTypeEnum MaterialType { set;get; }

AddProblematicGeometry(IEnumerable<IPSGeoEntity>, string)
Add a list of geometry entities has problemetic geometries.

Declaration Syntax
public void AddProblematicGeometry(IEnumerable<IPSGeoEntity> entities, string message)

Parameters
entities(IEnumerable<IPSGeoEntity>)

The list for geometry entities that are problematic.

message(string)

The message to display in the warning.

IDesignModelerSelectionInfo
Defines the DesignModeler selection information.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 173
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IDesignModelerSelectionInfo

Table 110: Members

Property Entities (p. 174) Gets the list of selected geometry entities.
Property Locations (p. 174) Gets the location point for each selected
entities.

Entities
Gets the list of selected geometry entities.

Declaration Syntax
public IList<IBaseGeoEntity> Entities { get; }

Locations
Gets the location point for each selected entities.

Declaration Syntax
public IList<double[]> Locations { set;get; }

IExtrude
Defines an "Extrude" operation.

Declaration Syntax
public interface IExtrude

Table 111: Members

Property Depth (p. 174) Gets or Sets the depth of the extrusion.
Property Direction (p. 175) Gets or Sets the direction of the extrusion.
Property Walled (p. 175) Gets or Sets the walled flag.
Method ApplyTo(IPSGeoEntity) (p. 175) Applies the operation to the profile given in
argument.

Depth
Gets or Sets the depth of the extrusion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
174 of ANSYS, Inc. and its subsidiaries and affiliates.
IGeometryBuilder

Declaration Syntax
public double Depth { set;get; }

Direction
Gets or Sets the direction of the extrusion.

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Walled
Gets or Sets the walled flag.

Declaration Syntax
public bool Walled { set;get; }

ApplyTo(IPSGeoEntity)
Applies the operation to the profile given in argument.

Declaration Syntax
public IEnumerable<IPSGeoBody> ApplyTo(IPSGeoEntity profile)

Parameters
profile(IPSGeoEntity)

The profile.

IGeometryBuilder
Defines the geometry builder.

Declaration Syntax
public interface IGeometryBuilder

Table 112: Members

Property Operations (p. 176) Gets the list of creatable


operations.
Property Primitives (p. 176) Gets the list of creatable
primitives.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 175
Ansys.ACT.Interfaces.DesignModeler Namespace

Operations
Gets the list of creatable operations.

Declaration Syntax
public IOperations Operations { get; }

Primitives
Gets the list of creatable primitives.

Declaration Syntax
public IPrimitives Primitives { get; }

IIntersect
Defines an "Intersect" operation.

Declaration Syntax
public interface IIntersect

Table 113: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 176) Applies the operation to the list of bodies given
in argument.

ApplyTo(IEnumerable<IPSGeoBody>)
Applies the operation to the list of bodies given in argument.

Declaration Syntax
public IEnumerable<IPSGeoBody> ApplyTo(IEnumerable<IPSGeoBody> bodiesIn)

Parameters
bodiesIn(IEnumerable<IPSGeoBody>)

The list of bodies.

IOperations
Defines a list of available geometry operations.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
176 of ANSYS, Inc. and its subsidiaries and affiliates.
IOperations

Declaration Syntax
public interface IOperations

Table 114: Members

Property Queries (p. 177) Gets the list of methods to


query information on the
geometry.
Property Tools (p. 177) Gets the list of additional
tools to manipulate the
geometry.
Method CreateExtrudeOperation(IEnumerable<double>, Creates an "Extrude"
double) (p. 177) operation.
Method CreateIntersectOperation(IEnumerable<IPSGeoBody>) (p. 178) Creates an "Intersect"
operation.
Method CreateRevolveOperation(IEnumerable<double>, Creates a "Revolve"
IEnumerable<double>) (p. 178) operation.
Method CreateSubtractOperation(IEnumerable<IPSGeoBody>) (p. 178) Creates a "Subtract"
operation.
Method CreateUnionOperation() (p. 179) Creates an "Union" operation.

Queries
Gets the list of methods to query information on the geometry.

Declaration Syntax
public IQueries Queries { get; }

Tools
Gets the list of additional tools to manipulate the geometry.

Declaration Syntax
public IOperationTools Tools { get; }

CreateExtrudeOperation(IEnumerable<double>, double)
Creates an "Extrude" operation.

Declaration Syntax
public IExtrude CreateExtrudeOperation(IEnumerable<double> dir, double depth)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 177
Ansys.ACT.Interfaces.DesignModeler Namespace

Parameters
dir(IEnumerable<double>)

Direction of the extrusion (x, y, z).

depth(double)

Depth of the extrusion.

CreateIntersectOperation(IEnumerable<IPSGeoBody>)
Creates an "Intersect" operation.

Declaration Syntax
public IIntersect CreateIntersectOperation(IEnumerable<IPSGeoBody> tools)

Parameters
tools(IEnumerable<IPSGeoBody>)

List of bodies to intersect.

CreateRevolveOperation(IEnumerable<double>, IEnumerable<double>)
Creates a "Revolve" operation.

Declaration Syntax
public IRevolve CreateRevolveOperation(IEnumerable<double> origin, IEnumerable<double> axis)

Parameters
origin(IEnumerable<double>)

Origin of the revolve (x, y, z).

axis(IEnumerable<double>)

Axis of the revolve (x, y, z).

CreateSubtractOperation(IEnumerable<IPSGeoBody>)
Creates a "Subtract" operation.

Declaration Syntax
public ISubtract CreateSubtractOperation(IEnumerable<IPSGeoBody> tools)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
178 of ANSYS, Inc. and its subsidiaries and affiliates.
IOperationTools

Parameters
tools(IEnumerable<IPSGeoBody>)

List of bodies to subtract.

CreateUnionOperation()
Creates an "Union" operation.

Declaration Syntax
public IUnion CreateUnionOperation()

IOperationTools
Defines a list of tools to manipulate the geometry.

Declaration Syntax
public interface IOperationTools

Table 115: Members

Method CopyBody(IPSGeoBody) (p. 180) Copies a body.


Method CreatePart(IEnumerable<IPSGeoBody>) (p. 180) Creates a new part (group of bodies).
Method DeleteBody(IPSGeoBody) (p. 180) Deletes a body.
Method EdgesToWireBody(IEnumerable<IPSGeoEdge>) (p. 180) Transforms a set of edges into a wire
body.
Method FacesToSheetBody(IEnumerable<IPSGeoFace>) (p. 181) Transforms a set of faces to a sheet
body.
Method Imprint(IPSGeoBody, Imprints a list of bodies to a target
IEnumerable<IPSGeoBody>) (p. 181) body.
Method OffsetFace(IEnumerable<IPSGeoFace>, double) (p. 181) Does a normal offset of faces with a
given offset value.
Method SheetBodyToSolidBody(IPSGeoBody) (p. 182) Transforms a sheet body to a solid
body.
Method SimplifyTopology(IPSGeoEntity) (p. 182) Simplifies the topology of the given
entity.
Method ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, Does a thicken operation on a body
double, double) (p. 182) and remove some faces.
Method TransformBody(IPSGeoBody, Matrix4D) (p. 183) Transform a body.
Method WireToSheetBody(IPSGeoBody) (p. 183) Transforms a wire body to a sheet
body.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 179
Ansys.ACT.Interfaces.DesignModeler Namespace

CopyBody(IPSGeoBody)
Copies a body.

Declaration Syntax
public IPSGeoBody CopyBody(IPSGeoBody body)

Parameters
body(IPSGeoBody)

The body to copy.

CreatePart(IEnumerable<IPSGeoBody>)
Creates a new part (group of bodies).

Declaration Syntax
public IPSGeoPart CreatePart(IEnumerable<IPSGeoBody> bodies)

Parameters
bodies(IEnumerable<IPSGeoBody>)

The list of bodies to group.

DeleteBody(IPSGeoBody)
Deletes a body.

Declaration Syntax
public void DeleteBody(IPSGeoBody body)

Parameters
body(IPSGeoBody)

The body to delete.

EdgesToWireBody(IEnumerable<IPSGeoEdge>)
Transforms a set of edges into a wire body.

Declaration Syntax
public IPSGeoBody EdgesToWireBody(IEnumerable<IPSGeoEdge> edges)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
180 of ANSYS, Inc. and its subsidiaries and affiliates.
IOperationTools

Parameters
edges(IEnumerable<IPSGeoEdge>)

List of edges to transform into a wire body.

FacesToSheetBody(IEnumerable<IPSGeoFace>)
Transforms a set of faces to a sheet body.

Declaration Syntax
public IPSGeoBody FacesToSheetBody(IEnumerable<IPSGeoFace> faces)

Parameters
faces(IEnumerable<IPSGeoFace>)

List of faces to transform in sheet body.

Imprint(IPSGeoBody, IEnumerable<IPSGeoBody>)
Imprints a list of bodies to a target body.

Declaration Syntax
public void Imprint(IPSGeoBody target, IEnumerable<IPSGeoBody> tools)

Parameters
target(IPSGeoBody)

The body on which imprint will be added.

tools(IEnumerable<IPSGeoBody>)

List of bodies to imprint.

OffsetFace(IEnumerable<IPSGeoFace>, double)
Does a normal offset of faces with a given offset value.

Declaration Syntax
public IPSGeoBody OffsetFace(IEnumerable<IPSGeoFace> faces, double offset)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 181
Ansys.ACT.Interfaces.DesignModeler Namespace

Parameters
faces(IEnumerable<IPSGeoFace>)

List of faces to offset.

offset(double)

Offset value.

SheetBodyToSolidBody(IPSGeoBody)
Transforms a sheet body to a solid body.

Declaration Syntax
public IPSGeoBody SheetBodyToSolidBody(IPSGeoBody sheet)

Parameters
sheet(IPSGeoBody)

The sheet body to transform.

SimplifyTopology(IPSGeoEntity)
Simplifies the topology of the given entity.

Declaration Syntax
public void SimplifyTopology(IPSGeoEntity entity)

Parameters
entity(IPSGeoEntity)

Entity to simplify.

ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, double, double)


Does a thicken operation on a body and remove some faces.

Declaration Syntax
public IPSGeoBody ThickenBody(IPSGeoBody body, IEnumerable<IPSGeoFace> facesToRemove, double
thick1, double thick2)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
182 of ANSYS, Inc. and its subsidiaries and affiliates.
IOperationTools

Parameters
body(IPSGeoBody)

The body to thicken

facesToRemove(IEnumerable<IPSGeoFace>)

List of faces to remove.

thick1(double)

Internal thickness.

thick2(double)

External thickness.

TransformBody(IPSGeoBody, Matrix4D)
Transform a body.

Declaration Syntax
public void TransformBody(IPSGeoBody body, Matrix4D transformation)

Parameters
body(IPSGeoBody)

The body to transform.

transformation(Matrix4D)

The transformation to apply.

WireToSheetBody(IPSGeoBody)
Transforms a wire body to a sheet body.

Declaration Syntax
public IPSGeoBody WireToSheetBody(IPSGeoBody wire)

Parameters
wire(IPSGeoBody)

The wire body to transform.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 183
Ansys.ACT.Interfaces.DesignModeler Namespace

IPrimitives
Defines the list of creatable primitives.

Declaration Syntax
public interface IPrimitives

Table 116: Members

Property Sheet (p. 184) Gets the list of all creatable sheet geometry
primitives.
Property Solid (p. 184) Gets the list of all creatable solid geometry
primitives.
Property Wire (p. 184) Gets the list of all creatable wire geometry
primitives.

Sheet
Gets the list of all creatable sheet geometry primitives.

Declaration Syntax
public ISheets Sheet { get; }

Solid
Gets the list of all creatable solid geometry primitives.

Declaration Syntax
public ISolids Solid { get; }

Wire
Gets the list of all creatable wire geometry primitives.

Declaration Syntax
public IWires Wire { get; }

IPSGeoBody
Defines a body.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
184 of ANSYS, Inc. and its subsidiaries and affiliates.
IQueries

Declaration Syntax
public interface IPSGeoBody

IPSGeoEdge
Defines an edge.

Declaration Syntax
public interface IPSGeoEdge

IPSGeoEntity
Defines a generic geometry entity.

Declaration Syntax
public interface IPSGeoEntity

IPSGeoFace
Defines a face.

Declaration Syntax
public interface IPSGeoFace

IPSGeoPart
Defines a part.

Declaration Syntax
public interface IPSGeoPart

IQueries
Defines a list of available queries on the geometry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 185
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IQueries

Table 117: Members

Method Clash(IEnumerable<IPSGeoEntity>, Detects clash between 2 sets of


IEnumerable<IPSGeoEntity>) (p. 186) geometry entities.
Method Coincidence(IPSGeoEntity, IPSGeoEntity) (p. 186) Checks if 2 geometry entities are
coincident.
Method Containment(IPSGeoEntity, IPSGeoEntity) (p. 187) Checks if one geometry entity contains
one other.
Method Distance(IEnumerable<IPSGeoEntity>, Computes the distance between 2 sets
IEnumerable<IPSGeoEntity>) (p. 187) of geometry entities.

Clash(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>)
Detects clash between 2 sets of geometry entities.

Declaration Syntax
public int Clash(IEnumerable<IPSGeoEntity> targets, IEnumerable<IPSGeoEntity> tools)

Parameters
targets(IEnumerable<IPSGeoEntity>)

List of target entities.

tools(IEnumerable<IPSGeoEntity>)

List of tool entities.

Coincidence(IPSGeoEntity, IPSGeoEntity)
Checks if 2 geometry entities are coincident.

Declaration Syntax
public int Coincidence(IPSGeoEntity first, IPSGeoEntity second)

Parameters
first(IPSGeoEntity)

The first geometry entity.

second(IPSGeoEntity)

The second geometry entity.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
186 of ANSYS, Inc. and its subsidiaries and affiliates.
IRevolve

Containment(IPSGeoEntity, IPSGeoEntity)
Checks if one geometry entity contains one other.

Declaration Syntax
public int Containment(IPSGeoEntity bigOne, IPSGeoEntity smallOne)

Parameters
bigOne(IPSGeoEntity)

The source geometry entity.

smallOne(IPSGeoEntity)

The target geometry entity.

Distance(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>)
Computes the distance between 2 sets of geometry entities.

Declaration Syntax
public double Distance(IEnumerable<IPSGeoEntity> targets, IEnumerable<IPSGeoEntity> tools)

Parameters
targets(IEnumerable<IPSGeoEntity>)

List of target entities.

tools(IEnumerable<IPSGeoEntity>)

List of tool entities.

IRevolve
Defines a "Revolve" operation.

Declaration Syntax
public interface IRevolve

Table 118: Members

Property Angle (p. 188) Gets or sets the angle of the revolution.
Property Axis (p. 188) Gets or sets the axis of the revolution (x, y, z).
Property Origin (p. 188) Gets or sets the origin of the revolution (x, y, z).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 187
Ansys.ACT.Interfaces.DesignModeler Namespace

Property Walled (p. 188) Gets or sets the walled flag.


Method ApplyTo(IPSGeoEntity) (p. 188) Applies the operation to a profile given in
argument.

Angle
Gets or sets the angle of the revolution.

Declaration Syntax
public double Angle { set;get; }

Axis
Gets or sets the axis of the revolution (x, y, z).

Declaration Syntax
public IEnumerable<double> Axis { set;get; }

Origin
Gets or sets the origin of the revolution (x, y, z).

Declaration Syntax
public IEnumerable<double> Origin { set;get; }

Walled
Gets or sets the walled flag.

Declaration Syntax
public bool Walled { set;get; }

ApplyTo(IPSGeoEntity)
Applies the operation to a profile given in argument.

Declaration Syntax
public IEnumerable<IPSGeoBody> ApplyTo(IPSGeoEntity profile)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
188 of ANSYS, Inc. and its subsidiaries and affiliates.
ISheetCone

Parameters
profile(IPSGeoEntity)

The profile to revolve.

ISheetCone
Defines a sheet cone primitive.

Declaration Syntax
public interface ISheetCone

Table 119: Members

Property Center (p. 189) Gets or sets the center of the cone (x, y,
z).
Property Direction (p. 189) Gets or sets the direction of the cone (x,
y, z).
Property Radius1 (p. 189) Gets or sets the top radius of the cone.
Property Radius2 (p. 190) Gets or sets the bottom radius of the
cone.

Center
Gets or sets the center of the cone (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Direction
Gets or sets the direction of the cone (x, y, z).

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Radius1
Gets or sets the top radius of the cone.

Declaration Syntax
public double Radius1 { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 189
Ansys.ACT.Interfaces.DesignModeler Namespace

Radius2
Gets or sets the bottom radius of the cone.

Declaration Syntax
public double Radius2 { set;get; }

ISheetCylinder
Defines a sheet cylinder primitive.

Declaration Syntax
public interface ISheetCylinder

Table 120: Members

Property Center (p. 190) Gets or sets the center of the


cylinder.
Property Direction (p. 190) Gets or sets the axis of the
cylinder.
Property Radius (p. 190) Gets or sets the radius of the
cylinder.

Center
Gets or sets the center of the cylinder.

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Direction
Gets or sets the axis of the cylinder.

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Radius
Gets or sets the radius of the cylinder.

Declaration Syntax
public double Radius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
190 of ANSYS, Inc. and its subsidiaries and affiliates.
ISheets

ISheetPolygon
Defines a sheet polygon primitive.

Declaration Syntax
public interface ISheetPolygon

Table 121: Members

Property Points (p. 191) Gets or sets the list of points (x1, y1, z1, x2, y2,
z2, ...)

Points
Gets or sets the list of points (x1, y1, z1, x2, y2, z2, ...)

Declaration Syntax
public IEnumerable<double> Points { set;get; }

ISheets
Defines the list all creatable sheet geometry primitives.

Declaration Syntax
public interface ISheets

Table 122: Members

Method CreateCylinder(IEnumerable<double>, Creates a sheet cylinder primitive


IEnumerable<double>, double) (p. 191) generator.
Method CreatePolygon(IEnumerable<double>) (p. 192) Creates a sheet polygon primitive
generator.

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


Creates a sheet cylinder primitive generator.

Declaration Syntax
public ISheetCylinder CreateCylinder(IEnumerable<double> center, IEnumerable<double> direction,
double radius)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 191
Ansys.ACT.Interfaces.DesignModeler Namespace

Parameters
center(IEnumerable<double>)

The center of the cylinder.

direction(IEnumerable<double>)

The main axis of the cylinder.

radius(double)

Radius of the cylinder.

CreatePolygon(IEnumerable<double>)
Creates a sheet polygon primitive generator.

Declaration Syntax
public ISheetPolygon CreatePolygon(IEnumerable<double> points)

Parameters
points(IEnumerable<double>)

The list of points.

ISheetSphere
Defines a sheet sphere primitive.

Declaration Syntax
public interface ISheetSphere

Table 123: Members

Property Center (p. 192) Gets or sets the center of the


sphere.
Property Radius (p. 193) Gets or sets the radius of the
sphere.

Center
Gets or sets the center of the sphere.

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
192 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolidCone

Radius
Gets or sets the radius of the sphere.

Declaration Syntax
public double Radius { set;get; }

ISolidBox
Defines a solid box primitive.

Declaration Syntax
public interface ISolidBox

Table 124: Members

Property Point1 (p. 193) Gets or sets the first point of the box (x, y,
z).
Property Point2 (p. 193) Gets or sets the second point of the box (x,
y, z).

Point1
Gets or sets the first point of the box (x, y, z).

Declaration Syntax
public IEnumerable<double> Point1 { set;get; }

Point2
Gets or sets the second point of the box (x, y, z).

Declaration Syntax
public IEnumerable<double> Point2 { set;get; }

ISolidCone
Defines a solid cone primitive.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 193
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface ISolidCone

Table 125: Members

Property Center (p. 194) Gets or sets the center of the cone (x, y,
z).
Property Direction (p. 194) Gets or sets the direction of the cone (x,
y, z).
Property Radius1 (p. 194) Gets or sets the top radius of the cone.
Property Radius2 (p. 194) Gets or sets the bottom radius of the
cone.

Center
Gets or sets the center of the cone (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Direction
Gets or sets the direction of the cone (x, y, z).

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Radius1
Gets or sets the top radius of the cone.

Declaration Syntax
public double Radius1 { set;get; }

Radius2
Gets or sets the bottom radius of the cone.

Declaration Syntax
public double Radius2 { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
194 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolids

ISolidCylinder
Defines a solid cylinder primitive.

Declaration Syntax
public interface ISolidCylinder

Table 126: Members

Property Center (p. 195) Gets or sets the center of the cylinder (x, y,
z).
Property Direction (p. 195) Gets or sets the direction of the cylinder (x,
y, z).
Property Radius (p. 195) Gets or sets the radius of the cylinder.

Center
Gets or sets the center of the cylinder (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Direction
Gets or sets the direction of the cylinder (x, y, z).

Declaration Syntax
public IEnumerable<double> Direction { set;get; }

Radius
Gets or sets the radius of the cylinder.

Declaration Syntax
public double Radius { set;get; }

ISolids
Defines the list of all creatable solid geometry primitives.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 195
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface ISolids

Table 127: Members

Method CreateBox(IEnumerable<double>, Creates a box primitive generator.


IEnumerable<double>) (p. 196)
Method CreateCone(IEnumerable<double>, Creates a cone primitive
IEnumerable<double>, double, double) (p. 196) generator.
Method CreateCylinder(IEnumerable<double>, Creates a cylinder primitive
IEnumerable<double>, double) (p. 197) generator.
Method CreateSphere(IEnumerable<double>, double) (p. 197) Creates a sphere primitive
generator.

CreateBox(IEnumerable<double>, IEnumerable<double>)
Creates a box primitive generator.

Declaration Syntax
public ISolidBox CreateBox(IEnumerable<double> pt1, IEnumerable<double> pt2)

Parameters
pt1(IEnumerable<double>)

First point of the box.

pt2(IEnumerable<double>)

Second point of the box.

CreateCone(IEnumerable<double>, IEnumerable<double>, double, double)


Creates a cone primitive generator.

Declaration Syntax
public ISolidCone CreateCone(IEnumerable<double> center, IEnumerable<double> direction, double
radius1, double radius2)

Parameters
center(IEnumerable<double>)

Center of the cone.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
196 of ANSYS, Inc. and its subsidiaries and affiliates.
ISolids

direction(IEnumerable<double>)

Direction of the cone.

radius1(double)

Top radius of the cone.

radius2(double)

Bottom radius of the cone.

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


Creates a cylinder primitive generator.

Declaration Syntax
public ISolidCylinder CreateCylinder(IEnumerable<double> center, IEnumerable<double> direction,
double radius)

Parameters
center(IEnumerable<double>)

The center of the cylinder.

direction(IEnumerable<double>)

The direction of the cylinder.

radius(double)

The radius of the cylinder.

CreateSphere(IEnumerable<double>, double)
Creates a sphere primitive generator.

Declaration Syntax
public ISolidSphere CreateSphere(IEnumerable<double> center, double radius)

Parameters
center(IEnumerable<double>)

The center of the sphere.

radius(double)

The radius of the sphere.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 197
Ansys.ACT.Interfaces.DesignModeler Namespace

ISolidSphere
Defines a solid sphere primitive.

Declaration Syntax
public interface ISolidSphere

Table 128: Members

Property Center (p. 198) Gets or sets the center of the sphere (x,
y, z).
Property Radius (p. 198) Gets or sets the radius of the sphere.

Center
Gets or sets the center of the sphere (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

Radius
Gets or sets the radius of the sphere.

Declaration Syntax
public double Radius { set;get; }

ISubtract
Defines a "Subtract" operation.

Declaration Syntax
public interface ISubtract

Table 129: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 198) Applies the operation to the list of bodies given
in argument.

ApplyTo(IEnumerable<IPSGeoBody>)
Applies the operation to the list of bodies given in argument.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
198 of ANSYS, Inc. and its subsidiaries and affiliates.
IWireArc

Declaration Syntax
public IEnumerable<IPSGeoBody> ApplyTo(IEnumerable<IPSGeoBody> bodiesIn)

Parameters
bodiesIn(IEnumerable<IPSGeoBody>)

The list of bodies on which bodies will be subtracted.

IUnion
Defines an "Union" operation.

Declaration Syntax
public interface IUnion

Table 130: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 199) Applies the operation to the list of bodies given
in argument.

ApplyTo(IEnumerable<IPSGeoBody>)
Applies the operation to the list of bodies given in argument.

Declaration Syntax
public IEnumerable<IPSGeoBody> ApplyTo(IEnumerable<IPSGeoBody> bodiesIn)

Parameters
bodiesIn(IEnumerable<IPSGeoBody>)

The list of bodies to combine.

IWireArc
Defines a wire arc primitive.

Declaration Syntax
public interface IWireArc

Table 131: Members

Property Center (p. 200) Gets or sets the center of the arc (x, y, z).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 199
Ansys.ACT.Interfaces.DesignModeler Namespace

Property EndAngle (p. 200) Gets or sets the end angle of the arc.
Property Normal (p. 200) Gets or sets the normal of the arc (x, y, z).
Property Radius (p. 200) Gets or sets the radius of the arc.
Property StartAngle (p. 200) Gets or sets the start angle of the arc.
Property XDir (p. 201) Gets or sets the principal dircetion of the arc (x,
y, z).

Center
Gets or sets the center of the arc (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

EndAngle
Gets or sets the end angle of the arc.

Declaration Syntax
public double EndAngle { set;get; }

Normal
Gets or sets the normal of the arc (x, y, z).

Declaration Syntax
public IEnumerable<double> Normal { set;get; }

Radius
Gets or sets the radius of the arc.

Declaration Syntax
public double Radius { set;get; }

StartAngle
Gets or sets the start angle of the arc.

Declaration Syntax
public double StartAngle { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
200 of ANSYS, Inc. and its subsidiaries and affiliates.
IWireEllipse

XDir
Gets or sets the principal dircetion of the arc (x, y, z).

Declaration Syntax
public IEnumerable<double> XDir { set;get; }

IWireBCurve
Defines awire b-curve primitive.

Declaration Syntax
public interface IWireBCurve

Table 132: Members

Property Closed (p. 201) Gets of sets the closed flag.


Property Points (p. 201) Gets or sets the list of points (x1, y1, z1, x2, y2,
z2, ...).

Closed
Gets of sets the closed flag.

Declaration Syntax
public bool Closed { set;get; }

Points
Gets or sets the list of points (x1, y1, z1, x2, y2, z2, ...).

Declaration Syntax
public IEnumerable<double> Points { set;get; }

IWireEllipse
Defines a wire ellipse primitive.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 201
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IWireEllipse

Table 133: Members

Property Center (p. 202) Gets or sets the center of the ellipse (x, y, z).
Property LargeRadius (p. 202) Gets or sets the large radius of the ellipse.
Property Normal (p. 202) Gets or sets the normal direction of the ellipse (x,
y, z).
Property SmallRadius (p. 202) Gets or sets the small radius of the ellipse.
Property XDir (p. 203) Gets or sets the principal direction of the ellipse (x,
y, z).

Center
Gets or sets the center of the ellipse (x, y, z).

Declaration Syntax
public IEnumerable<double> Center { set;get; }

LargeRadius
Gets or sets the large radius of the ellipse.

Declaration Syntax
public double LargeRadius { set;get; }

Normal
Gets or sets the normal direction of the ellipse (x, y, z).

Declaration Syntax
public IEnumerable<double> Normal { set;get; }

SmallRadius
Gets or sets the small radius of the ellipse.

Declaration Syntax
public double SmallRadius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
202 of ANSYS, Inc. and its subsidiaries and affiliates.
IWires

XDir
Gets or sets the principal direction of the ellipse (x, y, z).

Declaration Syntax
public IEnumerable<double> XDir { set;get; }

IWirePolyline
Defines a wire polyline primitive.

Declaration Syntax
public interface IWirePolyline

Table 134: Members

Property Points (p. 203) Gets or sets the list of points (x1, y1, z1, x2, y2,
z2, ...).

Points
Gets or sets the list of points (x1, y1, z1, x2, y2, z2, ...).

Declaration Syntax
public IEnumerable<double> Points { set;get; }

IWires
Defines the list of all creatable wire geometry primitives.

Declaration Syntax
public interface IWires

Table 135: Members

Method CreateArc(double, IEnumerable<double>, Creates an arc primitive


IEnumerable<double>, IEnumerable<double>) (p. 204) generator.
Method CreateBCurve(IEnumerable<double>) (p. 204) Creates a b-curve primitive
generator.
Method CreateEllipse(double, double, IEnumerable<double>, Creates an ellipse primitive
IEnumerable<double>, IEnumerable<double>) (p. 204) generator.
Method CreatePolyline(IEnumerable<double>) (p. 205) Creates a polyline primitive
generator.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 203
Ansys.ACT.Interfaces.DesignModeler Namespace

CreateArc(double, IEnumerable<double>, IEnumerable<double>, IEnumer-


able<double>)
Creates an arc primitive generator.

Declaration Syntax
public IWireArc CreateArc(double radius, IEnumerable<double> center, IEnumerable<double> xDir,
IEnumerable<double> normal)

Parameters
radius(double)

The radius of the arc.

center(IEnumerable<double>)

The center of the arc.

xDir(IEnumerable<double>)

The main direction of the arc.

normal(IEnumerable<double>)

The normal direction of the arc.

CreateBCurve(IEnumerable<double>)
Creates a b-curve primitive generator.

Declaration Syntax
public IWireBCurve CreateBCurve(IEnumerable<double> points)

Parameters
points(IEnumerable<double>)

The list of points.

CreateEllipse(double, double, IEnumerable<double>, IEnumerable<double>,


IEnumerable<double>)
Creates an ellipse primitive generator.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
204 of ANSYS, Inc. and its subsidiaries and affiliates.
IWires

Declaration Syntax
public IWireEllipse CreateEllipse(double largeRadius, double smallRadius, IEnumerable<double> center,
IEnumerable<double> xDir, IEnumerable<double> normal)

Parameters
largeRadius(double)

The large radius of the ellipse.

smallRadius(double)

The small radius of the ellipse.

center(IEnumerable<double>)

The center of the ellipse.

xDir(IEnumerable<double>)

The main direction of the ellipse.

normal(IEnumerable<double>)

The normal direction of the ellipse.

CreatePolyline(IEnumerable<double>)
Creates a polyline primitive generator.

Declaration Syntax
public IWirePolyline CreatePolyline(IEnumerable<double> points)

Parameters
points(IEnumerable<double>)

The list of points.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 205
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
206 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Graphics

Table 136: Members

IModelViewManager (p. 207) No details are provided for this


entry.

IModelViewManager
No details are provided for this entry.

Declaration Syntax
public interface IModelViewManager

Table 137: Members

Property NumberOfViews (p. 208) The number of views currently defined.


Method ApplyModelView(int) (p. 208) Apply the view specified by index.
Method ApplyModelView(string) (p. 208) Apply the view specified by name.
Method CaptureModelView(int, string) (p. 208) Save the view specified by index as a PNG image
to the project userfiles.
Method CaptureModelView(string, string) (p. 209) Save the view specified as an image to the
project userfiles.
Method CreateView() (p. 209) Create a view from current graphics with default
naming.
Method CreateView(string) (p. 209) Create a view from current graphics with the
specified name.
Method DeleteView(int) (p. 209) Delete the specified view by index.
Method DeleteView(string) (p. 210) Apply the view specified by name.
Method ExportModelViews(string) (p. 210) Export model views to the specified file.
Method ImportModelViews(string) (p. 210) Import model views from the specified file.
Method RenameView(int, string) (p. 211) Rename the model view specified by viewIndex
to newLabel.
Method RenameView(string, string) (p. 211) Rename the model view specified to newLabel.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 207
Ansys.ACT.Interfaces.Graphics Namespace

NumberOfViews
The number of views currently defined.

Declaration Syntax
public int NumberOfViews { get; }

ApplyModelView(int)
Apply the view specified by index.

Declaration Syntax
public void ApplyModelView(int viewIndex)

Parameters
viewIndex(int)

The index of the listed view to be applied.

ApplyModelView(string)
Apply the view specified by name.

Declaration Syntax
public void ApplyModelView(string viewLabel)

Parameters
viewLabel(string)

The name of the view to be applied.

CaptureModelView(int, string)
Save the view specified by index as a PNG image to the project userfiles.

Declaration Syntax
public void CaptureModelView(int index, string mode)

Parameters
index(int)

The index of the view to be saved.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
208 of ANSYS, Inc. and its subsidiaries and affiliates.
IModelViewManager

mode(string)

A string representing the graphics format to use. One of : "PNG", "JPG", "BMP".

CaptureModelView(string, string)
Save the view specified as an image to the project userfiles.

Declaration Syntax
public void CaptureModelView(string viewLabel, string mode)

Parameters
viewLabel(string)

The name of the view to be saved.

mode(string)

A string representing the graphics format to use. One of : "PNG", "JPG", "BMP".

CreateView()
Create a view from current graphics with default naming.

Declaration Syntax
public void CreateView()

CreateView(string)
Create a view from current graphics with the specified name.

Declaration Syntax
public void CreateView(string viewName)

Parameters
viewName(string)

The name to be assigned to the new view.

DeleteView(int)
Delete the specified view by index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 209
Ansys.ACT.Interfaces.Graphics Namespace

Declaration Syntax
public void DeleteView(int viewIndex)

Parameters
viewIndex(int)

The index of the listed view to be deleted.

DeleteView(string)
Apply the view specified by name.

Declaration Syntax
public void DeleteView(string viewLabel)

Parameters
viewLabel(string)

The name of the view to be applied.

ExportModelViews(string)
Export model views to the specified file.

Declaration Syntax
public void ExportModelViews(string viewfilepath)

Parameters
viewfilepath(string)

The name of the view (xml) export file.

ImportModelViews(string)
Import model views from the specified file.

Declaration Syntax
public void ImportModelViews(string viewfilepath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
210 of ANSYS, Inc. and its subsidiaries and affiliates.
IModelViewManager

Parameters
viewfilepath(string)

The name of the view (xml) file to be imported.

RenameView(int, string)
Rename the model view specified by viewIndex to newLabel.

Declaration Syntax
public void RenameView(int viewIndex, string newLabel)

Parameters
viewIndex(int)

The index of the listed view to be renamed.

newLabel(string)

Th new name to be applied.

RenameView(string, string)
Rename the model view specified to newLabel.

Declaration Syntax
public void RenameView(string viewLabel, string newLabel)

Parameters
viewLabel(string)

The label of the listed view to be renamed.

newLabel(string)

Th new name to be applied.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 211
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
212 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Mechanical

Table 138: Members

IMechanicalDataModel (p. 213) Defines the data model of the Mechanical


application.
IMechanicalExtAPI (p. 215) Exposes the main entry point of all ATC APIs.
IMechanicalGraphics (p. 215) Interface for MechanicalGraphics.
IMechanicalSelectionInfo (p. 216) Defines the mechanical selection information.
IMechanicalUserLoad (p. 217) Defines a Mechanical user load.
IMechanicalUserObject (p. 217) Defines a Mechanical user object.
IMechanicalUserResult (p. 217) Defines a Mechanical user result.
IMechanicalUserSolver (p. 218) Defines a Mechanical user solver.
MechanicalPanelEnum (p. 218) Specifies the panel type.

IMechanicalDataModel
Defines the data model of the Mechanical application.

Declaration Syntax
public interface IMechanicalDataModel

Table 139: Members

Property ObjectTags (p. 214) Gets the ObjectTags object for the Data
Model, which represents the current list of
tags visable in the User Interface.
Property Project (p. 214) Gets the project object. Main object of the
tree of Mechanical.
Property Tree (p. 214) Gets the tree of Mechanical.
Method CurrentUnitFromQuantityName(string) (p. 214) Returns the current unit from a quantity
name.
Method GetUserObjectById(int) (p. 214) Gets the user object based on the application
id.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 213
Ansys.ACT.Interfaces.Mechanical Namespace

ObjectTags
Gets the ObjectTags object for the Data Model, which represents the current list of tags visable in
the User Interface.

Declaration Syntax
public ObjectTags ObjectTags { get; }

Project
Gets the project object. Main object of the tree of Mechanical.

Declaration Syntax
public Project Project { get; }

Tree
Gets the tree of Mechanical.

Declaration Syntax
public Tree Tree { get; }

CurrentUnitFromQuantityName(string)
Returns the current unit from a quantity name.

Declaration Syntax
public string CurrentUnitFromQuantityName(string quantityName)

Parameters
quantityName(string)

The quantity name to query.

GetUserObjectById(int)
Gets the user object based on the application id.

Declaration Syntax
public IUserObject GetUserObjectById(int id)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
214 of ANSYS, Inc. and its subsidiaries and affiliates.
IMechanicalGraphics

Parameters
id(int)

Application object id.

IMechanicalExtAPI
Exposes the main entry point of all ATC APIs.

Declaration Syntax
public interface IMechanicalExtAPI

Table 140: Members

Method LockPrePostLicense() (p. 215) Locks the license used by the PRE/POST application.
Method UnlockPrePostLicense() (p. 215) R Unlocks the license used by the PRE/POST application. This
is required if you want to manually launch the Ansys solver.
You must relock the license after its use. If you don't relock
the license, the PRE/POST application will be in read-only
mode.

LockPrePostLicense()
Locks the license used by the PRE/POST application.

Declaration Syntax
public void LockPrePostLicense()

UnlockPrePostLicense()
R Unlocks the license used by the PRE/POST application. This is required if you want to manually
launch the Ansys solver. You must relock the license after its use. If you don't relock the license, the
PRE/POST application will be in read-only mode.

Declaration Syntax
public void UnlockPrePostLicense()

IMechanicalGraphics
Interface for MechanicalGraphics.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 215
Ansys.ACT.Interfaces.Mechanical Namespace

Declaration Syntax
public interface IMechanicalGraphics

Table 141: Members

Property ModelViewManager (p. 216) An instance of the


ModelViewManager.
Property SectionPlanes (p. 216) An instance of the SectionPlanes.

ModelViewManager
An instance of the ModelViewManager.

Declaration Syntax
public IModelViewManager ModelViewManager { get; }

SectionPlanes
An instance of the SectionPlanes.

Declaration Syntax
public SectionPlanes SectionPlanes { get; }

IMechanicalSelectionInfo
Defines the mechanical selection information.

Declaration Syntax
public interface IMechanicalSelectionInfo

Table 142: Members

Property ElementFaceIndices (p. 216) Gets the list indices needed to define the face of an
element.
Property Entities (p. 217) Gets the list of selected geometry entities.

ElementFaceIndices
Gets the list indices needed to define the face of an element.

Declaration Syntax
public IList<int> ElementFaceIndices { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
216 of ANSYS, Inc. and its subsidiaries and affiliates.
IMechanicalUserResult

Entities
Gets the list of selected geometry entities.

Declaration Syntax
public IList<IGeoEntity> Entities { get; }

IMechanicalUserLoad
Defines a Mechanical user load.

Declaration Syntax
public interface IMechanicalUserLoad

IMechanicalUserObject
Defines a Mechanical user object.

Declaration Syntax
public interface IMechanicalUserObject

Table 143: Members

Property Analysis (p. 217) Gets the associated


analysis.

Analysis
Gets the associated analysis.

Declaration Syntax
public IAnalysis Analysis { get; }

IMechanicalUserResult
Defines a Mechanical user result.

Declaration Syntax
public interface IMechanicalUserResult

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 217
Ansys.ACT.Interfaces.Mechanical Namespace

IMechanicalUserSolver
Defines a Mechanical user solver.

Declaration Syntax
public interface IMechanicalUserSolver

MechanicalPanelEnum
Specifies the panel type.

Declaration Syntax
public enum MechanicalPanelEnum

Table 144: Members

Member DataView The data view panel.


Member Graph The graph (or time line)
panel.
Member Graphics The graphics panel.
Member Outline The outline panel.
Member TabularData The tabular data panel.
Member Wizard The wizard panel.
Member Worksheet The worksheet panel.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
218 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Common Namespace
Declaration Syntax
namespace Ansys.ACT.Common

Table 145: Members

CoordinateSystem (p. 219) CoordinateSystem class


SimpleTransform (p. 221) Exposes simple getters and setters for rigid body
transformations.

CoordinateSystem
CoordinateSystem class

Declaration Syntax
public class CoordinateSystem : ICoordinateSystem

Table 146: Members

Constructor CoordinateSystem(CoordinateSystemTypeEnum) (p. 220) Constructor.


Property CoordinateSystemType (p. 220) Gets or sets the coordinate
system type.
Property Id (p. 220) Gets or sets the ID of the
coordinate system.
Property Matrix (p. 220) Gets or sets the matrix
definition of the coordinate
system.
Property Name (p. 220) Gets or sets the name of the
coordinate system.
Property Origin (p. 221) Gets or sets the origin of the
coordinate system.
Property XAxis (p. 221) Gets or sets the X axis of the
coordinate system.
Property YAxis (p. 221) Gets or sets the Y axis of the
coordinate system.
Property ZAxis (p. 221) Gets or sets the Z axis of the
coordinate system.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 219
Ansys.ACT.Common Namespace

CoordinateSystem(CoordinateSystemTypeEnum)
Constructor.

Declaration Syntax
public CoordinateSystem(CoordinateSystemTypeEnum type)

Parameters
type(CoordinateSystemTypeEnum)

The CoordinateSystemTypeEnum type to construct.

CoordinateSystemType
Gets or sets the coordinate system type.

Declaration Syntax
public CoordinateSystemTypeEnum CoordinateSystemType { set;get; }

Id
Gets or sets the ID of the coordinate system.

Declaration Syntax
public int Id { set;get; }

Matrix
Gets or sets the matrix definition of the coordinate system.

Declaration Syntax
public IEnumerable<double> Matrix { set;get; }

Name
Gets or sets the name of the coordinate system.

Declaration Syntax
public string Name { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
220 of ANSYS, Inc. and its subsidiaries and affiliates.
SimpleTransform

Origin
Gets or sets the origin of the coordinate system.

Declaration Syntax
public IEnumerable<double> Origin { set;get; }

XAxis
Gets or sets the X axis of the coordinate system.

Declaration Syntax
public IEnumerable<double> XAxis { set;get; }

YAxis
Gets or sets the Y axis of the coordinate system.

Declaration Syntax
public IEnumerable<double> YAxis { set;get; }

ZAxis
Gets or sets the Z axis of the coordinate system.

Declaration Syntax
public IEnumerable<double> ZAxis { set;get; }

SimpleTransform
Exposes simple getters and setters for rigid body transformations.

Declaration Syntax
public class SimpleTransform

Table 147: Members

Constructor SimpleTransform() (p. 222) No details are provided for this entry.
Property IsOrthonormal (p. 222) Returns `true` if the provided axis vectors are all normalized
and orthogonal.
Property TransformationMatrix (p. 222) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 221
Ansys.ACT.Common Namespace

Property Translation (p. 222) The translation of the transformation with respect to the
global/world coordinate system.
Property XAxis (p. 222) The X-axis orientation of the transformation with respect
to the global/world coordinate system.
Property YAxis (p. 223) The Y-axis orientation of the transformation with respect
to the global/world coordinate system.
Property ZAxis (p. 223) The X-axis orientation of the transformation with respect
to the global/world coordinate system.

SimpleTransform()
No details are provided for this entry.

Declaration Syntax
public SimpleTransform()

IsOrthonormal
Returns `true` if the provided axis vectors are all normalized and orthogonal.

Declaration Syntax
public bool IsOrthonormal { get; }

TransformationMatrix
No details are provided for this entry.

Declaration Syntax
public RigidBodyTransformationMatrix TransformationMatrix { set;get; }

Translation
The translation of the transformation with respect to the global/world coordinate system.

Declaration Syntax
public Point3D Translation { set;get; }

XAxis
The X-axis orientation of the transformation with respect to the global/world coordinate system.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
222 of ANSYS, Inc. and its subsidiaries and affiliates.
SimpleTransform

Declaration Syntax
public Vector3D XAxis { set;get; }

YAxis
The Y-axis orientation of the transformation with respect to the global/world coordinate system.

Declaration Syntax
public Vector3D YAxis { set;get; }

ZAxis
The X-axis orientation of the transformation with respect to the global/world coordinate system.

Declaration Syntax
public Vector3D ZAxis { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 223
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
224 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Common.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Common.Graphics

Table 148: Members

DMCameraWrapper (p. 225) Wrapper for Camera in Design


Modeler.
DMGraphicsWrapper (p. 225) Wrapper for Graphics in Design
Modeler.
MechanicalCameraWrapper (p. 225) Wrapper for Camera in Mechanical.
MechanicalGraphicsWrapper (p. 229) Wrapper for Graphics in Mechanical.
ModelViewManager (p. 232) No details are provided for this
entry.

DMCameraWrapper
Wrapper for Camera in Design Modeler.

Declaration Syntax
public class DMCameraWrapper : CameraWrapper, ICamera

DMGraphicsWrapper
Wrapper for Graphics in Design Modeler.

Declaration Syntax
public class DMGraphicsWrapper : GraphicsWrapper, IGraphics

MechanicalCameraWrapper
Wrapper for Camera in Mechanical.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 225
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public class MechanicalCameraWrapper : CameraWrapper

Table 149: Members

Property FocalPoint (p. 226) The focal point of the camera


(coordinates are in the global
coordinate system).
Property SceneHeight (p. 226) Specifies the scene height (in
length units) that will be
projected and fit to the viewport.
Property SceneWidth (p. 227) Specifies the scene width (in
length units) that will be
projected and fit to the viewport.
Property UpVector (p. 227) The vector pointing up from the
focal point.
Property ViewVector (p. 227) The vector pointing from the focal
point to the camera.
Method GetAsString(ApplicationType) (p. 227) Retrieves the view commands as
related to the application type as
a string.
Method Pan(Quantity, Quantity) (p. 227) Shifts the camera position
horizontally or vertically based on
x and y quantities.
Method Rotate(double, CameraAxisType) (p. 228) Rotates the camera about an axis.
Method SetFit(ISelectionInfo) (p. 228) Fits the view to the specified
selection. If null is supplied, fits
the view to the entire model.
Method SetSpecificViewOrientation(ViewOrientationType) (p. 228)Sets a specific view orientation.
Method Zoom(double) (p. 229) Zooms in or out on the model.

FocalPoint
The focal point of the camera (coordinates are in the global coordinate system).

Declaration Syntax
public Point FocalPoint { set;get; }

SceneHeight
Specifies the scene height (in length units) that will be projected and fit to the viewport.

Declaration Syntax
public Quantity SceneHeight { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
226 of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalCameraWrapper

SceneWidth
Specifies the scene width (in length units) that will be projected and fit to the viewport.

Declaration Syntax
public Quantity SceneWidth { set;get; }

UpVector
The vector pointing up from the focal point.

Declaration Syntax
public Vector3D UpVector { set;get; }

ViewVector
The vector pointing from the focal point to the camera.

Declaration Syntax
public Vector3D ViewVector { set;get; }

GetAsString(ApplicationType)
Retrieves the view commands as related to the application type as a string.

Declaration Syntax
public string GetAsString(ApplicationType appType)

Parameters
appType(ApplicationType)

The appication type (Mechanical, MAPDL).

Pan(Quantity, Quantity)
Shifts the camera position horizontally or vertically based on x and y quantities.

Declaration Syntax
public void Pan(Quantity x, Quantity y)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 227
Ansys.ACT.Common.Graphics Namespace

Parameters
x(Quantity)

No details are provided for this entry.

y(Quantity)

No details are provided for this entry.

Rotate(double, CameraAxisType)
Rotates the camera about an axis.

Declaration Syntax
public void Rotate(double angle, CameraAxisType axis)

Parameters
angle(double)

The amount of rotation (positive = Clockwise : negative = Counter-Clockwise).

axis(CameraAxisType)

The axis of rotation (ScreenX, ScreenY, ScreenZ, GlobalX, GlobalY, GlobalZ).

SetFit(ISelectionInfo)
Fits the view to the specified selection. If null is supplied, fits the view to the entire model.

Declaration Syntax
public void SetFit(ISelectionInfo sel)

Parameters
sel(ISelectionInfo)

The fit selection (null = full model, geometry selection).

SetSpecificViewOrientation(ViewOrientationType)
Sets a specific view orientation.

Declaration Syntax
public void SetSpecificViewOrientation(ViewOrientationType type)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
228 of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalGraphicsWrapper

Parameters
type(ViewOrientationType)

A view type (ISO, Front, Back, Left, Right, Top, Bottom).

Zoom(double)
Zooms in or out on the model.

Declaration Syntax
public void Zoom(double zoomVal)

Parameters
zoomVal(double)

No details are provided for this entry.

MechanicalGraphicsWrapper
Wrapper for Graphics in Mechanical.

Declaration Syntax
public class MechanicalGraphicsWrapper : GraphicsWrapper, IMechanicalGraphics

Table 150: Members

Property Camera (p. 230) Gets the camera.


Property GlobalLegendSettings (p. 230) Gets the Global Graphics Legend Settings.
Property KeyframeAnimationUtility (p. 230) A utility for creating animations based on
keyframes.
Property ModelViewManager (p. 230) An instance of the ModelViewManager.
Property ResultAnimationOptions (p. 230) Gets the Global Result Animation options.
Property SectionPlanes (p. 230) Returns the collection of section planes
used by graphics
Property Unit (p. 231) Gets the current graphics unit.
Property ViewOptions (p. 231) Gets the Graphics View Options.
Method Export3D(string, Graphics3DExportFormat, Exports the current Graphics display in a 3d
Graphics3DExportSettings) (p. 231) format to a file.
Method ExportImage(string, Exports the current graphics display to a 2D
GraphicsImageExportFormat, image file.
GraphicsImageExportSettings) (p. 231)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 229
Ansys.ACT.Common.Graphics Namespace

Method ExportViewports(string, Creates a composite of images exported


GraphicsImageExportFormat, from each open viewport.
GraphicsViewportsExportSettings) (p. 232)

Camera
Gets the camera.

Declaration Syntax
public MechanicalCameraWrapper Camera { get; }

GlobalLegendSettings
Gets the Global Graphics Legend Settings.

Declaration Syntax
public GlobalLegendSettings GlobalLegendSettings { get; }

KeyframeAnimationUtility
A utility for creating animations based on keyframes.

Declaration Syntax
public KeyframeAnimationUtility KeyframeAnimationUtility { get; }

ModelViewManager
An instance of the ModelViewManager.

Declaration Syntax
public IModelViewManager ModelViewManager { get; }

ResultAnimationOptions
Gets the Global Result Animation options.

Declaration Syntax
public ResultAnimationOptions ResultAnimationOptions { get; }

SectionPlanes
Returns the collection of section planes used by graphics

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
230 of ANSYS, Inc. and its subsidiaries and affiliates.
MechanicalGraphicsWrapper

Declaration Syntax
public SectionPlanes SectionPlanes { get; }

Unit
Gets the current graphics unit.

Declaration Syntax
public string Unit { get; }

ViewOptions
Gets the Graphics View Options.

Declaration Syntax
public ViewOptions ViewOptions { get; }

Export3D(string, Graphics3DExportFormat, Graphics3DExportSettings)


Exports the current Graphics display in a 3d format to a file.

Declaration Syntax
public void Export3D(string filePath, Graphics3DExportFormat format3d, Graphics3DExportSettings
settings)

Parameters
filePath(string)

The file path to create the 3d image.

format3d(Graphics3DExportFormat)

The 3d format to use when exporting.

settings(Graphics3DExportSettings)

The 3d settings to use when exporting.

ExportImage(string, GraphicsImageExportFormat, GraphicsImageExportSet-


tings)
Exports the current graphics display to a 2D image file.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 231
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public void ExportImage(string filePath, GraphicsImageExportFormat formatImage, GraphicsImageEx-
portSettings settings)

Parameters
filePath(string)

The output image's file path. Non-existent directories will be created and pre-existing files will
be overwritten.

formatImage(GraphicsImageExportFormat)

The 2D image format to use when exporting.

settings(GraphicsImageExportSettings)

The 2D image settings to use when exporting.

ExportViewports(string, GraphicsImageExportFormat, GraphicsViewports-


ExportSettings)
Creates a composite of images exported from each open viewport.

Declaration Syntax
public void ExportViewports(string filePath, GraphicsImageExportFormat format, GraphicsViewports-
ExportSettings settings)

Parameters
filePath(string)

The output image's file path. Non-existent directories will be created and pre-existing files will
be overwritten.

format(GraphicsImageExportFormat)

The 2D image format to use when exporting.

settings(GraphicsViewportsExportSettings)

The settings to use when exporting. The width and height parameters dictate the output image's
total size (rather than the subimages' sizes).

ModelViewManager
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
232 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelViewManager

Declaration Syntax
public class ModelViewManager : IModelViewManager

Table 151: Members

Property ActiveViewPort (p. 233) No details are provided for this entry.
Property NumberOfViews (p. 233) The number of views currently defined.
Method ApplyModelView(int) (p. 233) Apply the view specified by index.
Method ApplyModelView(string) (p. 234) Apply the view specified by name.
Method CreateView() (p. 234) Create a view from current graphics with default
naming.
Method CreateView(string) (p. 234) Create a view from current graphics with the specified
name.
Method DeleteView(int) (p. 234) Delete the specified view by index.
Method DeleteView(string) (p. 235) Delete the specified view by name.
Method ExportModelViews(string) (p. 235) Export model views to the specified file.
Method ImportModelViews(string) (p. 235) Import model views from the specified file.
Method RenameView(int, string) (p. 236) Rename the model view specified by viewIndex to
newLabel.
Method RenameView(string, string) (p. 236) Rename the model view specified to newLabel.
Method SetActiveViewPort(int) (p. 236) Active a viewport.
Method SetActiveViewPort(int, int) (p. 237) Set the active of viewport.
Method SetViewPorts(int, bool) (p. 237) Set the number of viewports displayed.

ActiveViewPort
No details are provided for this entry.

Declaration Syntax
public MechanicalViewPort ActiveViewPort { get; }

NumberOfViews
The number of views currently defined.

Declaration Syntax
public int NumberOfViews { get; }

ApplyModelView(int)
Apply the view specified by index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 233
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public virtual void ApplyModelView(int viewIndex)

Parameters
viewIndex(int)

The index of the listed view to be applied.

ApplyModelView(string)
Apply the view specified by name.

Declaration Syntax
public virtual void ApplyModelView(string viewLabel)

Parameters
viewLabel(string)

The name of the view to be applied.

CreateView()
Create a view from current graphics with default naming.

Declaration Syntax
public virtual void CreateView()

CreateView(string)
Create a view from current graphics with the specified name.

Declaration Syntax
public virtual void CreateView(string viewName)

Parameters
viewName(string)

The name to be assigned to the new view.

DeleteView(int)
Delete the specified view by index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
234 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelViewManager

Declaration Syntax
public virtual void DeleteView(int viewIndex)

Parameters
viewIndex(int)

The index of the listed view to be deleted.

DeleteView(string)
Delete the specified view by name.

Declaration Syntax
public virtual void DeleteView(string viewLabel)

Parameters
viewLabel(string)

The name of the view to be deleted.

ExportModelViews(string)
Export model views to the specified file.

Declaration Syntax
public virtual void ExportModelViews(string viewfilepath)

Parameters
viewfilepath(string)

The name of the view (xml) export file.

ImportModelViews(string)
Import model views from the specified file.

Declaration Syntax
public virtual void ImportModelViews(string viewfilepath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 235
Ansys.ACT.Common.Graphics Namespace

Parameters
viewfilepath(string)

The name of the view (xml) file to be imported.

RenameView(int, string)
Rename the model view specified by viewIndex to newLabel.

Declaration Syntax
public virtual void RenameView(int viewIndex, string newLabel)

Parameters
viewIndex(int)

The index of the listed view to be renamed.

newLabel(string)

The new name to be applied.

RenameView(string, string)
Rename the model view specified to newLabel.

Declaration Syntax
public virtual void RenameView(string viewLabel, string newLabel)

Parameters
viewLabel(string)

The label of the listed view to be renamed.

newLabel(string)

The new name to be applied.

SetActiveViewPort(int)
Active a viewport.

Declaration Syntax
public void SetActiveViewPort(int windowsId)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
236 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelViewManager

Parameters
windowsId(int)

The window index of the viewport to be made active.

SetActiveViewPort(int, int)
Set the active of viewport.

Declaration Syntax
public void SetActiveViewPort(int winRowIndex, int winColIndex)

Parameters
winRowIndex(int)

The row index of the viewport to be made active (The index is zero referenced).

winColIndex(int)

The column index of the viewport to be made active (The index is zero referenced).

SetViewPorts(int, bool)
Set the number of viewports displayed.

Declaration Syntax
public void SetViewPorts(int numViewPorts, bool horizontal)

Parameters
numViewPorts(int)

The number of viewports to display.

horizontal(bool)

Alignment is horizontal if "true" and vertical if "false". Applies when numViewPorts is 2.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 237
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
238 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.DesignModeler

Table 152: Members

Extrusion (p. 239) Defines a Extrusion.


Feature (p. 240) Defines a Feature.
FeatureManager (p. 241) Defines a
FeatureManager.
NamedSelection (p. 242) Defines a
NamedSelection.

Extrusion
Defines a Extrusion.

Declaration Syntax
public class Extrusion : Feature

Table 153: Members

Property Depth (p. 240) Gets or sets the Depth.


Property Depth2 (p. 240) Gets or sets the Depth2.
Property Id (p. 241) Gets the id of the feature.

(Inherited from
Feature (p. 240).)
Property Name (p. 241) Gets the name of the
feature.

(Inherited from
Feature (p. 240).)
Property Thin1 (p. 240) Gets or sets the Thin1.
Property Thin2 (p. 240) Gets or sets the Thin2.
Property Walled (p. 240) Gets or sets the Walled.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 239
Ansys.ACT.Automation.DesignModeler Namespace

Depth
Gets or sets the Depth.

Declaration Syntax
public Quantity Depth { set;get; }

Depth2
Gets or sets the Depth2.

Declaration Syntax
public Quantity Depth2 { set;get; }

Thin1
Gets or sets the Thin1.

Declaration Syntax
public Quantity Thin1 { set;get; }

Thin2
Gets or sets the Thin2.

Declaration Syntax
public Quantity Thin2 { set;get; }

Walled
Gets or sets the Walled.

Declaration Syntax
public YesNo Walled { set;get; }

Feature
Defines a Feature.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
240 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureManager

Declaration Syntax
public class Feature

Table 154: Members

Property Id (p. 241) Gets the id of the


feature.
Property Name (p. 241) Gets the name of the
feature.

Id
Gets the id of the feature.

Declaration Syntax
public uint Id { get; }

Name
Gets the name of the feature.

Declaration Syntax
public string Name { set;get; }

FeatureManager
Defines a FeatureManager.

Declaration Syntax
public class FeatureManager : IEnumerable<Feature>, IEnumerable

Table 155: Members

Property Count (p. 241) Gets the number of features.


Property Item (p. 242) Gets a feature by its index.
Method CreateNamedSelection() (p. 242) Creates a new NamedSelection
feature.
Method Generate() (p. 242) Generates non-generated features
if any.

Count
Gets the number of features.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 241
Ansys.ACT.Automation.DesignModeler Namespace

Declaration Syntax
public int Count { get; }

Item(int)
Gets a feature by its index.

Declaration Syntax
public Feature Item { get; }

CreateNamedSelection()
Creates a new NamedSelection feature.

Declaration Syntax
public NamedSelection CreateNamedSelection()

Generate()
Generates non-generated features if any.

Declaration Syntax
public void Generate()

NamedSelection
Defines a NamedSelection.

Declaration Syntax
public class NamedSelection : Feature

Table 156: Members

Property ExportNamedSelection (p. 243) Gets or sets the


ExportNamedSelection.
Property Id (p. 241) Gets the id of the feature.

(Inherited from Feature (p. 240).)


Property IncludeInLegend (p. 243) Gets or sets the IncludeInLegend.
Property Name (p. 241) Gets the name of the feature.

(Inherited from Feature (p. 240).)


Property NumGeometry (p. 243) Gets the NumGeometry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
242 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

Property PropagateNamedSelection (p. 243) Gets or sets the


PropagateNamedSelection.

ExportNamedSelection
Gets or sets the ExportNamedSelection.

Declaration Syntax
public YesNo ExportNamedSelection { set;get; }

IncludeInLegend
Gets or sets the IncludeInLegend.

Declaration Syntax
public YesNo IncludeInLegend { set;get; }

NumGeometry
Gets the NumGeometry.

Declaration Syntax
public int NumGeometry { get; }

PropagateNamedSelection
Gets or sets the PropagateNamedSelection.

Declaration Syntax
public YesNo PropagateNamedSelection { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 243
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
244 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical

Table 157: Members

AcousticsFarFieldResultWorksheet (p. 251) No details are provided for this entry.


AMOverhangConstraint (p. 255) Defines a AMOverhangConstraint.
Analysis (p. 257) Defines a Analysis.
AnalysisPly (p. 295) Defines a AnalysisPly.
ArbitraryCrack (p. 299) Defines a ArbitraryCrack.
ArchiveSettings (p. 304) A settings class for the project Archive operation
BatchConnectionsWorksheet (p. 305) No details are provided for this entry.
Body (p. 311) Defines a Body.
CenterOfGravityConstraint (p. 330) Defines a CenterOfGravityConstraint.
ChannelCrossSection (p. 332) Defines a ChannelCrossSection.
Chart (p. 335) Defines a Chart.
ChartXAxis (p. 340) No details are provided for this entry.
CircularCrossSection (p. 341) Defines a CircularCrossSection.
CircularTubeCrossSection (p. 342) Defines a CircularTubeCrossSection.
CommandSnippet (p. 344) Defines a CommandSnippet.
Comment (p. 353) Defines a Comment.
ComplexityIndexConstraint (p. 355) Defines a ComplexityIndexConstraint.

Defines a ComplexityIndexConstraint.
ComplianceConstraint (p. 356) Defines a ComplianceConstraint.
CompositeCriterion (p. 357) Defines a CompositeCriterion.
CompositeCriterionDefinition (p. 359) No details are provided for this entry.
CompositeCriterionTerm (p. 361) No details are provided for this entry.
CondensedGeometry (p. 363) Defines a CondensedGeometry.
CondensedPart (p. 367) Defines a CondensedPart.
CondensedPartBase (p. 373) Defines a CondensedPartBase.
CondensedPartExpansionState (p. 379) No details are provided for this entry.
CondensedPartInfoTool (p. 380) Defines a CondensedPartInfoTool.
CondensedPartInterface (p. 383) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 245
Ansys.ACT.Automation.Mechanical Namespace

CondensedPartInterfaces (p. 384) A collection of condensed part interface.


ConstructionGeometry (p. 386) Defines a ConstructionGeometry.
ConstructionPoint (p. 391) Defines a ConstructionPoint.
ContactDebonding (p. 395) Defines a ContactDebonding.
ContactMatch (p. 398) Defines a ContactMatch.
ContactMatchGroup (p. 400) Defines a ContactMatchGroup.

Defines a ContactMatchGroup.
ContactSolutionInformation (p. 403) Defines a ContactSolutionInformation.
CoordinateSystem (p. 406) Defines a CoordinateSystem.
CoordinateSystems (p. 423) Defines a CoordinateSystems.
CornerCrack (p. 427) Defines a CornerCrack.
CoSimulationPin (p. 433) Defines a CoSimulationPin.
Crack ***OBSOLETE*** Deprecated class. Use Defines a Crack.
ArbitraryCrack or SemiEllipticalCrack
instead. (p. 436)
CrackInitiation (p. 442) Defines a CrackInitiation.
Criterion (p. 446) Defines a Criterion.
CriterionConstraint (p. 450) Defines a CriterionConstraint.
CrossSection (p. 451) Defines a CrossSection.
CrossSections (p. 455) Defines a CrossSections.
CyclicManufacturingConstraint (p. 461) Defines a CyclicManufacturingConstraint.
CyclicRegion (p. 462) Defines a CyclicRegion.
CylindricalCrack (p. 464) Defines a CylindricalCrack.
DirectMorph (p. 470) Defines a DirectMorph.
DisplacementConstraint (p. 473) Defines a DisplacementConstraint.
DistributedMass (p. 475) Defines a DistributedMass.
DynamicComplianceConstraint (p. 477) Defines a DynamicComplianceConstraint.
EdgeCrack (p. 479) Defines a EdgeCrack.
ElementOrientation (p. 485) Defines a ElementOrientation.
EllipticalCrack (p. 490) Defines a EllipticalCrack.
EndRelease (p. 496) Defines a EndRelease.
ExpansionSettings (p. 502) Defines a ExpansionSettings.
ExternalEnhancedModel (p. 509) Defines a ExternalEnhancedModel.
ExternalModelDataColl (p. 513) Defines a ExternalModelDataColl.
ExtrusionManufacturingConstraint (p. 517) Defines a ExtrusionManufacturingConstraint.
FatigueCombination (p. 519) Defines a FatigueCombination.
FatigueTool (p. 522) Defines a FatigueTool.
FeatureDetection (p. 531) Defines a FeatureDetection.
FeatureDetectionDefinition (p. 536) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
246 of ANSYS, Inc. and its subsidiaries and affiliates.
Figure (p. 546) Defines a Figure.
Fracture (p. 549) Defines a Fracture.
GeneralAxisymmetric (p. 555) Defines a GeneralAxisymmetric.
GenericCrack (p. 560) Defines a GenericCrack.
GenericDelamination (p. 564) Defines a GenericDelamination.
GenericPointMass (p. 568) Defines a GenericPointMass.
Geometry (p. 572) Defines a Geometry.
GeometryFileContainer (p. 591) Defines a GeometryFileContainer.
GeometryImport (p. 595) Defines a GeometryImport.
GeometryImportGroup (p. 600) Defines a GeometryImportGroup.
GlobalVonMisesStressConstraint (p. 604) Defines a GlobalVonMisesStressConstraint.

Defines a GlobalVonMisesStressConstraint.
HatCrossSection (p. 605) Defines a HatCrossSection.
HollowRectangularCrossSection (p. 609) Defines a HollowRectangularCrossSection.
HousingConstraint (p. 611) Defines a HousingConstraint.

Defines a HousingConstraint.
ICrossSection (p. 613) Defines a ICrossSection.
Image (p. 616) Defines a Image.
ImagePlane (p. 619) Defines a ImagePlane.
ImportedBoltPretensions (p. 624) Defines a ImportedBoltPretensions.
ImportedCondensedPart (p. 625) Defines a ImportedCondensedPart.
ImportedConstraintEquations (p. 634) Defines a ImportedConstraintEquations.
ImportedContacts (p. 635) Defines a ImportedContacts.
ImportedCoordinateSystems (p. 636) Defines a ImportedCoordinateSystems.
ImportedElementOrientations (p. 637) Defines a ImportedElementOrientations.
ImportedFlexibleRemoteConnectors (p. 639) Defines a ImportedFlexibleRemoteConnectors.
ImportedLayeredSection (p. 640) Defines a ImportedLayeredSection.
ImportedNodalOrientations (p. 641) Defines a ImportedNodalOrientations.
ImportedObject (p. 642) Defines a row object in Imported Objects.
ImportedPlies (p. 644) Defines a ImportedPlies.
ImportedPliesCollection (p. 645) Defines a ImportedPliesCollection.
ImportedPointMasses (p. 649) Defines a ImportedPointMasses.
ImportedPremeshedBoltPretensions (p. 650) Defines a ImportedPremeshedBoltPretensions.
ImportedRigidRemoteConnectors (p. 651) Defines a ImportedRigidRemoteConnectors.
ImportedShellThicknesses (p. 652) Defines a ImportedShellThicknesses.
ImportedSpringConnectors (p. 653) Defines a ImportedSpringConnectors.
ImportedStresses (p. 654) Defines a ImportedStresses.
InitialCondition (p. 655) Defines a InitialCondition.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 247
Ansys.ACT.Automation.Mechanical Namespace

InitialConditions (p. 668) Defines a InitialConditions.


InterfaceDelamination (p. 672) Defines a InterfaceDelamination.
JointBushingWorksheet (p. 676) The worksheet of stiffness and damping
coefficients for a bushing type joint.
LayeredSection (p. 685) Defines a LayeredSection.
LayeredSectionWorksheet (p. 690) No details are provided for this entry.
LCrossSection (p. 696) Defines a LCrossSection.
LineChart2D (p. 698) Defines a LineChart2D.
LoadHelper (p. 700) No details are provided for this entry.
LocalVonMisesStressConstraint (p. 701) Defines a LocalVonMisesStressConstraint.
ManufacturingConstraint (p. 702) Defines a ManufacturingConstraint.

Defines a ManufacturingConstraint.
MappingValidation (p. 705) Defines a MappingValidation.
MassConstraint (p. 711) Defines a MassConstraint.
Material (p. 714) Defines a Material.
MaterialAssignment (p. 718) Defines a MaterialAssignment.
MaterialPlot (p. 724) Defines a MaterialPlot.
Materials (p. 727) Defines a Materials.
Measures (p. 732) Defines a Measures.
MemberSizeManufacturingConstraint (p. 736) Defines a MemberSizeManufacturingConstraint.
MeshConnection (p. 738) Defines a MeshConnection.
MeshConnectionBase (p. 742) Defines a MeshConnectionBase.

Defines a MeshConnectionBase.
MeshConnectionGroup (p. 748) Defines a MeshConnectionGroup.
MeshControlWorksheet (p. 751) No details are provided for this entry.
MeshEdit (p. 755) Defines a MeshEdit.
MeshExtrude (p. 762) Pull method enables you to extrude or revolve
element faces, topofaces or scoped bodies (only
shell body) from a surface or solid mesh. Pull also
allows to create surface coating on solid bodies,
element faces and topofaces.
MeshNumbering (p. 771) Defines a MeshNumbering.
Model (p. 775) Defines a Model.
ModelImport (p. 806) Defines a ModelImport.
MomentOfInertiaConstraint (p. 815) Defines a MomentOfInertiaConstraint.
MorphingRegion (p. 818) Defines a MorphingRegion.
NamedSelection (p. 824) Defines a NamedSelection.
NamedSelectionCriteria (p. 832) A collection of named selection criteria.
NamedSelectionCriterion (p. 835) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
248 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelections (p. 838) Defines a NamedSelections.
NastranExportOptions (p. 843) Defines the NastranExportOptions.
NaturalFrequencyConstraint (p. 846) Defines a NaturalFrequencyConstraint.
NodeMerge (p. 848) Defines a NodeMerge.

Defines a NodeMerge.
NodeMergeGroup (p. 853) Defines a NodeMergeGroup.
NodeMove (p. 856) Defines a NodeMove.
NumberingControl (p. 861) Defines a NumberingControl.
Objective (p. 866) Defines a Objective.
ObjectiveWorksheet (p. 869) No details are provided for this entry.
OptimizationMaterial (p. 879) No details are provided for this entry.
OptimizationRegion (p. 881) Defines a OptimizationRegion.
OptimizationRegionBaseClass (p. 886) Defines a OptimizationRegionBaseClass.
ParameterVariable (p. 889) Defines a ParameterVariable.
ParameterVariableGroup (p. 892) Defines a ParameterVariableGroup.
Part (p. 895) Defines a Part.
PartTransform (p. 905) Defines a PartTransform.
PartTransformGroup (p. 911) Defines a PartTransformGroup.
Path (p. 915) Defines a Path.
PatternRepetitionConstraint (p. 922) Defines a PatternRepetitionConstraint.
PeriodicRegion (p. 924) Defines a PeriodicRegion.
PhysicsRegion (p. 926) Defines a PhysicsRegion.
PipeIdealization (p. 935) Defines a PipeIdealization.
PointMass (p. 938) Defines a PointMass.
PostContactTool (p. 942) Defines a PostContactTool.
PreContactTool (p. 944) Defines a PreContactTool.
PreMeshedCrack (p. 946) Defines a PreMeshedCrack.
PreMeshedCyclicRegion (p. 949) Defines a PreMeshedCyclicRegion.
PrimaryCriterion (p. 950) Defines a PrimaryCriterion.
Project (p. 956) Defines a Project.
PullOutDirectionManufacturingConstraint (p. 966) Defines a
PullOutDirectionManufacturingConstraint.
PythonCode (p. 968) Defines a PythonCode.
PythonCodeEventBased (p. 970) Defines a PythonCodeEventBased.
ReactionForceConstraint (p. 972) Defines a ReactionForceConstraint.
RectangularCrossSection (p. 975) Defines a RectangularCrossSection.
RemotePoint (p. 976) Defines a RemotePoint.
RemotePoints (p. 984) Defines a RemotePoints.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 249
Ansys.ACT.Automation.Mechanical Namespace

Defines a RemotePoints.
ResponseConstraint (p. 988) Defines a ResponseConstraint.
ResponsePSDTool (p. 990) Defines a ResponsePSDTool.
ResultMesh (p. 995) Defines a ResultMesh.
RingCrack (p. 1000) Defines a RingCrack.
SelectionWorksheet (p. 1007) No details are provided for this entry.
SemiEllipticalCrack (p. 1019) Defines a SemiEllipticalCrack.
SMARTCrackGrowth (p. 1026) Defines a SMARTCrackGrowth.
Solid (p. 1032) Defines a Solid.
Solution (p. 1036) Defines a Solution.
SolutionCombination (p. 1114) Defines a SolutionCombination.
SolutionCombinationDefinition (p. 1130) No details are provided for this entry.
SolutionInformation (p. 1139) Defines a SolutionInformation.
Stage (p. 1164) Defines a Stage.
STL (p. 1170) Defines a STL.
SubstructureGenerationCondensedPart (p. 1173) Defines a SubstructureGenerationCondensedPart.
Surface (p. 1176) Defines a Surface.
SurfaceCoating (p. 1179) Defines a SurfaceCoating.
Symmetry (p. 1184) Defines a Symmetry.
SymmetryGeneral (p. 1188) Defines a SymmetryGeneral.
SymmetryManufacturingConstraint (p. 1193) Defines a SymmetryManufacturingConstraint.
SymmetryRegion (p. 1195) Defines a SymmetryRegion.
Table (p. 1197) Defines a Table.
TableGroup (p. 1208) Defines a TableGroup.
TCrossSection (p. 1212) Defines a TCrossSection.
TemperatureConstraint (p. 1214) Defines a TemperatureConstraint.
ThermalComplianceConstraint (p. 1216) Defines a ThermalComplianceConstraint.
ThermalPointMass (p. 1217) Defines a ThermalPointMass.
Thickness (p. 1220) Defines a Thickness.
ThroughCrack (p. 1225) Defines a ThroughCrack.
Tree (p. 1232) No details are provided for this entry.
TreeGroupingFolder (p. 1239) Defines a TreeGroupingFolder.
UniformConstraint (p. 1242) Defines a UniformConstraint.
UserDefinedCrossSection (p. 1243) Defines a UserDefinedCrossSection.
VirtualCell (p. 1246) Defines a VirtualCell.
VirtualTopology (p. 1250) Defines a VirtualTopology.
VolumeConstraint (p. 1262) Defines a VolumeConstraint.
Worksheet (p. 1264) No details are provided for this entry.
ZCrossSection (p. 1264) Defines a ZCrossSection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
250 of ANSYS, Inc. and its subsidiaries and affiliates.
AcousticsFarFieldResultWorksheet

AcousticsFarFieldResultWorksheet
No details are provided for this entry.

Declaration Syntax
public class AcousticsFarFieldResultWorksheet : Worksheet

Table 158: Members

Property RowCount (p. 251) Return the number of entries.


Method AddRow() (p. 251) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 251) Deletes a row from the worksheet at index.
Method DuplicateRow(int, int) (p. 252) Insert a row from the worksheet at index.
Method GetCoordinateSystemSelection(int) (p. 252) Gets the worksheet CoordinateSystemSelection
property at index.
Method GetXCoordinate(int) (p. 252) Gets the worksheet Mic X property at index.
Method GetYCoordinate(int) (p. 253) Gets the worksheet Mic Y property at index.
Method GetZCoordinate(int) (p. 253) Gets the worksheet Mic Z property at index.
Method InsertRow(int) (p. 253) Insert a row from the worksheet at index.
Method SetCoordinateSystemSelection(int, Sets the worksheet CoordinateSystemSelection
uint) (p. 254) property at index.
Method SetXCoordinate(int, double) (p. 254) Sets the worksheet Mic X property at index.
Method SetYCoordinate(int, double) (p. 254) Sets the worksheet Mic Y property at index.
Method SetZCoordinate(int, double) (p. 255) Sets the worksheet Mic Z property at index.

RowCount
Return the number of entries.

Declaration Syntax
public int RowCount { get; }

AddRow()
Adds a Row to the worksheet.

Declaration Syntax
public override int AddRow()

DeleteRow(int)
Deletes a row from the worksheet at index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 251
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)

No details are provided for this entry.

DuplicateRow(int, int)
Insert a row from the worksheet at index.

Declaration Syntax
public virtual int DuplicateRow(int fromIndex, int toIndex)

Parameters
fromIndex(int)

No details are provided for this entry.

toIndex(int)

No details are provided for this entry.

GetCoordinateSystemSelection(int)
Gets the worksheet CoordinateSystemSelection property at index.

Declaration Syntax
public uint GetCoordinateSystemSelection(int index)

Parameters
index(int)

No details are provided for this entry.

GetXCoordinate(int)
Gets the worksheet Mic X property at index.

Declaration Syntax
public double GetXCoordinate(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
252 of ANSYS, Inc. and its subsidiaries and affiliates.
AcousticsFarFieldResultWorksheet

Parameters
index(int)

No details are provided for this entry.

GetYCoordinate(int)
Gets the worksheet Mic Y property at index.

Declaration Syntax
public double GetYCoordinate(int index)

Parameters
index(int)

No details are provided for this entry.

GetZCoordinate(int)
Gets the worksheet Mic Z property at index.

Declaration Syntax
public double GetZCoordinate(int index)

Parameters
index(int)

No details are provided for this entry.

InsertRow(int)
Insert a row from the worksheet at index.

Declaration Syntax
public virtual int InsertRow(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
Ansys.ACT.Automation.Mechanical Namespace

SetCoordinateSystemSelection(int, uint)
Sets the worksheet CoordinateSystemSelection property at index.

Declaration Syntax
public void SetCoordinateSystemSelection(int index, uint newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(uint)

No details are provided for this entry.

SetXCoordinate(int, double)
Sets the worksheet Mic X property at index.

Declaration Syntax
public void SetXCoordinate(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(double)

No details are provided for this entry.

SetYCoordinate(int, double)
Sets the worksheet Mic Y property at index.

Declaration Syntax
public void SetYCoordinate(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
254 of ANSYS, Inc. and its subsidiaries and affiliates.
AMOverhangConstraint

newVal(double)

No details are provided for this entry.

SetZCoordinate(int, double)
Sets the worksheet Mic Z property at index.

Declaration Syntax
public void SetZCoordinate(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(double)

No details are provided for this entry.

AMOverhangConstraint
Defines a AMOverhangConstraint.

Declaration Syntax
public class AMOverhangConstraint : ManufacturingConstraint

Table 159: Members

Property BuildDirection (p. 256) Gets or sets the BuildDirection.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 256) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 256)Gets the current DataModelObject's
category.
Property InternalObject (p. 256) Gets the internal object. For advanced usage
only.
Property OverhangAngle (p. 256) Gets or sets the OverhangAngle.
Property ScopingMethod (p. 256) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
Ansys.ACT.Automation.Mechanical Namespace

Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

BuildDirection
Gets or sets the BuildDirection.

Declaration Syntax
public CoordinateSystemAxisType BuildDirection { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

OverhangAngle
Gets or sets the OverhangAngle.

Declaration Syntax
public Quantity OverhangAngle { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Analysis
Defines a Analysis.

Declaration Syntax
public class Analysis : ImportedDataModelObject, IAnalysis, IDataModelObject, IApplicationObject,
IDataObjectContainer, IInternalDataObjectContainer, IExtensionDMOperationRecorder, IComponentsPro-
vider, IFolderDataModelObject

Table 160: Members

Property Acoustics (p. 262) Gets or sets the Acoustics.


Property AMProcessSimulation (p. 262) Gets or sets the AMProcessSimulation.
Property AnalysisSettings (p. 262) Gets the AnalysisSettings.
Property AnalysisType (p. 263) Gets the AnalysisType.
Property CellId (p. 263) Gets the CellId.
Property Children (p. 263) Gets the list of children.
Property Comments (p. 263) Gets the list of associated comments.
Property DataModelObjectCategory (p. 263) Gets the current DataModelObject's category.
Property Electric (p. 263) Gets the Electric.
Property EnvironmentTemperature (p. 264) Gets or sets the EnvironmentTemperature.
Property Figures (p. 264) Gets the list of associated figures.
Property GenerateInputOnly (p. 264) Gets the GenerateInputOnly.
Property Images (p. 264) Gets the list of associated images.
Property InitialConditions (p. 264) Get InitialConditions.
Property InternalObject (p. 264) Gets the internal object. For advanced usage only.
Property PhysicsType (p. 265) Gets the PhysicsType.
Property ResultFileName (p. 265) Get the full path and name of the result file.
Property Solution (p. 265) Gets the Solution.
Property Structural (p. 265) Gets or sets the Structural.
Property SystemCaption (p. 265) Gets the SystemCaption.
Property Thermal (p. 265) Gets the Thermal.
Method AddAcceleration() (p. 266) Creates a new Acceleration
Method AddAcousticAbsorptionElement() (p. 266) Creates a new AcousticAbsorptionElement
Method AddAcousticAbsorptionSurface() (p. 266) Creates a new AcousticAbsorptionSurface
Method AddAcousticDiffuseSoundField() (p. 266) Creates a new AcousticDiffuseSoundField
Method AddAcousticFarFieldRadationSurface() (p. 266) Creates a new AcousticFarFieldRadationSurface

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
Ansys.ACT.Automation.Mechanical Namespace

Method AddAcousticFreeSurface() (p. 266) Creates a new AcousticFreeSurface


Method AddAcousticImpedanceBoundary() (p. 267) Creates a new AcousticImpedanceBoundary
Method AddAcousticImpedanceSheet() (p. 267) Creates a new AcousticImpedanceSheet
Method AddAcousticIncidentWaveSource() (p. 267) Creates a new AcousticIncidentWaveSource
Method AddAcousticLowReducedFrequency() (p. 267) Creates a new AcousticLowReducedFrequency
Method AddAcousticMassSource() (p. 267) Creates a new AcousticMassSource
Method AddAcousticMassSourceRate() (p. 267) Creates a new AcousticMassSourceRate
Method AddAcousticPort() (p. 268) Creates a new AcousticPort
Method AddAcousticPortInDuct() (p. 268) Creates a new AcousticPortInDuct
Method AddAcousticPressure() (p. 268) Creates a new AcousticPressure
Method AddAcousticRadiationBoundary() (p. 268) Creates a new AcousticRadiationBoundary
Method AddAcousticRigidWall() (p. 268) Creates a new AcousticRigidWall
Method AddAcousticStaticPressure() (p. 268) Creates a new AcousticStaticPressure
Method AddAcousticSurfaceAcceleration() (p. 269) Creates a new AcousticSurfaceAcceleration
Method AddAcousticSurfaceVelocity() (p. 269) Creates a new AcousticSurfaceVelocity
Method AddAcousticSymmetryPlane() (p. 269) Creates a new AcousticSymmetryPlane
Method AddAcousticTemperature() (p. 269) Creates a new child ThermalCondition.
Method AddAcousticThermoViscousBLIBoundary() (p. 269) Creates a new AcousticThermoViscousBLIBoundary
Method AddAcousticTransferAdmittanceMatrix() (p. 269) Creates a new AcousticTransferAdmittanceMatrix
Method AddAMOverhangConstraint() (p. 270) Creates a new AMOverhangConstraint
Method AddBearingLoad() (p. 270) Creates a new BearingLoad
Method AddBodyControl() (p. 270) Creates a new BodyControl
Method AddBoltPretension() (p. 270) Creates a new BoltPretension
Method AddCenterOfGravityConstraint() (p. 270) Creates a new CenterOfGravityConstraint
Method AddCommandSnippet() (p. 270) Creates a new CommandSnippet
Method AddComment() (p. 271) Creates a new child Comment.
Method AddComplexityIndexConstraint() (p. 271) Creates a new ComplexityIndexConstraint
Method AddComplianceConstraint() (p. 271) Creates a new ComplianceConstraint
Method AddCompressionOnlySupport() (p. 271) Creates a new CompressionOnlySupport
Method AddConstraintEquation() (p. 271) Creates a new ConstraintEquation
Method AddContactStepControl() (p. 271) Creates a new ContactStepControl
Method AddConvection(DataRepresentation) (p. 272) No details are provided for this entry.
Method AddCoupling() (p. 272) Creates a new Coupling
Method AddCriterionConstraint() (p. 272) Creates a new CriterionConstraint
Method AddCurrent() (p. 272) Creates a new Current
Method AddCyclicManufacturingConstraint() (p. 273) Creates a new CyclicManufacturingConstraint
Method AddCylindricalSupport() (p. 273) Creates a new CylindricalSupport
Method AddDetonationPoint() (p. 273) Creates a new DetonationPoint
Method AddDisplacement() (p. 273) Creates a new Displacement

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Method AddDisplacementConstraint() (p. 273) Creates a new DisplacementConstraint


Method AddDynamicComplianceConstraint() (p. 273) Creates a new DynamicComplianceConstraint
Method AddEarthGravity() (p. 274) Creates a new EarthGravity
Method AddElasticSupport() (p. 274) Creates a new ElasticSupport
Method AddElectricCharge() (p. 274) Creates a new ElectricCharge
Method AddElementBirthAndDeath() (p. 274) Creates a new ElementBirthAndDeath
Method AddEMTransducer() (p. 274) Creates a new EMTransducer
Method AddExtrusionManufacturingConstraint() (p. 274) Creates a new ExtrusionManufacturingConstraint
Method AddFigure() (p. 275) Creates a new child Figure.
Method AddFixedRotation() (p. 275) Creates a new FixedRotation
Method AddFixedSupport() (p. 275) Creates a new FixedSupport
Method AddFluidPenetrationPressure() (p. 275) Creates a new Fluid Penetration Pressure object in
Mechanical. This load object is used to simulate
surrounding fluid or air penetrating into the contac
interface. Users can apply this load to
flexible-to-flexible or rigid-to-flexible contact pairs.
This load object is available for static structural
analysis.
Method AddFluidSolidInterface() (p. 275) Creates a new FluidSolidInterface
Method AddForce() (p. 275) Creates a new Force
Method AddFrictionlessSupport() (p. 276) Creates a new FrictionlessSupport
Method AddGeneralizedPlaneStrain() (p. 276) Creates a new GeneralizedPlaneStrain
Method AddGeometryBasedAdaptivity() (p. 276) Creates a new GeometryBasedAdaptivity
Method AddGlobalVonMisesStressConstraint() (p. 276) Creates a new GlobalVonMisesStressConstraint
Method AddHeatFlow() (p. 276) Creates a new HeatFlow
Method AddHeatFlux() (p. 276) Creates a new HeatFlux
Method AddHousingConstraint() (p. 277) Creates a new HousingConstraint
Method AddHydrostaticPressure() (p. 277) Creates a new HydrostaticPressure
Method AddImage(string) (p. 277) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddImpedanceBoundary() (p. 277) Creates a new ImpedanceBoundary
Method AddImportedCFDPressure() (p. 277) Creates a new ImportedCFDPressure
Method AddImportedLoadExternalData() (p. 278) Creates a new Imported Load (External Data).
Method AddImportedLoadFluidsResultsFile() (p. 278) Creates a new Import Load for Fluids Results File.
Method AddImportedLoadMAPDLResultsFile() (p. 278) Creates a new Import Load for MAPDL Results File.
Method AddImportedRemoteLoadsGroup() (p. 278) Creates a new Import Remote Load Group.
Method AddInitialVelocity() (p. 278) Creates a new child Initial Velocity.
Method AddInternalHeatGeneration() (p. 278) Creates a new InternalHeatGeneration
Method AddJointLoad() (p. 279) Creates a new JointLoad

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
Ansys.ACT.Automation.Mechanical Namespace

Method AddLimitBoundary() (p. 279) Creates a new LimitBoundary


Method AddLinePressure() (p. 279) Creates a new LinePressure
Method AddLocalVonMisesStressConstraint() (p. 279) Creates a new LocalVonMisesStressConstraint
Method AddMagneticFluxParallel() (p. 279) Creates a new MagneticFluxParallel
Method AddMassConstraint() (p. 279) Creates a new MassConstraint
Method AddMassFlowRate() (p. 280) Creates a new MassFlowRate
Method AddMemberSizeManufacturingConstraint() (p. 280) Creates a new MemberSizeManufacturingConstrain
Method AddMoment() (p. 280) Creates a new Moment
Method AddMomentOfInertiaConstraint() (p. 280) Creates a new MomentOfInertiaConstraint
Method AddMorphingRegion() (p. 280) Creates a new MorphingRegion
Method AddNaturalFrequencyConstraint() (p. 280) Creates a new NaturalFrequencyConstraint
Method AddNodalDisplacement() (p. 281) Creates a new NodalDisplacement
Method AddNodalForce() (p. 281) Creates a new NodalForce
Method AddNodalOrientation() (p. 281) Creates a new NodalOrientation
Method AddNodalPressure() (p. 281) Creates a new NodalPressure
Method AddNodalRotation() (p. 281) Creates a new NodalRotation
Method AddNonlinearAdaptiveRegion() (p. 281) Creates a new NonlinearAdaptiveRegion
Method AddObjective() (p. 282) Creates a new Objective
Method AddOptimizationRegion() (p. 282) Creates a new OptimizationRegion
Method AddPatternRepetitionConstraint() (p. 282) Creates a new PatternRepetitionConstraint
Method AddPerfectlyInsulated() (p. 282) Creates a new PerfectlyInsulated
Method AddPhysicsRegion() (p. 282) Creates a new PhysicsRegion
Method AddPipeIdealization() (p. 282) Creates a new child PipeIdealization.
Method AddPipePressure() (p. 283) Creates a new PipePressure
Method AddPipeTemperature() (p. 283) Creates a new PipeTemperature
Method AddPlasticHeating() (p. 283) Creates a new PlasticHeating
Method AddPressure(DataRepresentation) (p. 283) Creates a new child Pressure.
DataRepresentation.Field will use the Field object
for working with tabular data
DataRepresentation.Flexible allows the use of the
following types when the pressure is defined as a
normal to a surface: Quantity: The unit must be a
valid Pressure unit string: It is interpreted as s table
if it matches a Table name. Else it is interpreted as
an expresion Table: A table object can be specified
Method AddPSDAcceleration() (p. 283) Creates a new PSDAcceleration
Method AddPSDDisplacement() (p. 284) Creates a new PSDDisplacement
Method AddPSDGAcceleration() (p. 284) Creates a new PSDGAcceleration
Method AddPSDVelocity() (p. 284) Creates a new PSDVelocity
Method AddPullOutDirectionManufacturingConstraint() (p. 284) Creates a new
PullOutDirectionManufacturingConstraint

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Method AddPythonCodeEventBased() (p. 284) Creates a new PythonCodeEventBased


Method AddRadiation() (p. 284) Creates a new Radiation
Method AddReactionForceConstraint() (p. 285) Creates a new ReactionForceConstraint
Method AddRemoteDisplacement() (p. 285) Creates a new RemoteDisplacement
Method AddRemoteForce() (p. 285) Creates a new RemoteForce
Method AddRotatingForce() (p. 285) Creates a new RotatingForce
Method AddRotationalAcceleration() (p. 285) Creates a new RotationalAcceleration
Method AddRotationalVelocity() (p. 285) Creates a new RotationalVelocity
Method AddRSAcceleration() (p. 286) Creates a new RSAcceleration
Method AddRSDisplacement() (p. 286) Creates a new RSDisplacement
Method AddRSVelocity() (p. 286) Creates a new RSVelocity
Method AddSimplySupported() (p. 286) Creates a new SimplySupported
Method AddSourceConductor() (p. 286) Creates a new child SourceConductor.
Method AddSubstructureGenerationCondensedPart() (p. 286) Creates a new
SubstructureGenerationCondensedPart
Method AddSurfaceChargeDensity() (p. 287) Creates a new SurfaceChargeDensity
Method AddSymmetryManufacturingConstraint() (p. 287) Creates a new SymmetryManufacturingConstraint
Method AddSystemCouplingRegion() (p. 287) Creates a new SystemCouplingRegion
Method AddTemperature(DataRepresentation) (p. 287) Creates a new child Temperature.
Method AddTemperatureConstraint() (p. 288) Creates a new TemperatureConstraint
Method AddThermalComplianceConstraint() (p. 288) Creates a new ThermalComplianceConstraint
Method AddThermalCondition() (p. 288) Creates a new child ThermalCondition.
Method AddThermalCondition(DataRepresentation) (p. 288) No details are provided for this entry.
Method AddUniformConstraint() (p. 288) Creates a new UniformConstraint
Method AddVelocity() (p. 289) Creates a new Velocity
Method AddViscoelasticHeating() (p. 289) Creates a new ViscoelasticHeating
Method AddVoltage() (p. 289) Creates a new Voltage
Method AddVoltageCoupling() (p. 289) Creates a new Coupling
Method AddVoltageGround() (p. 289) Creates a new VoltageGround
Method AddVolumeChargeDensity() (p. 289) Creates a new VolumeChargeDensity
Method AddVolumeConstraint() (p. 290) Creates a new VolumeConstraint
Method ClearGeneratedData() (p. 290) Run the ClearGeneratedData action.
Method CreateAutomaticFarFieldRadiationSurfaces() (p. 290) Run the CreateAutomaticEquivalentSourceSurfaces
action.
Method CreateAutomaticFSI() (p. 290) Run the CreateAutomaticFSI action.
Method CreateAutomaticFSIandFarFieldRadiationSurfaces() (p. 290) Run the
CreateAutomaticFSIandEquivalentSourceSurfaces
action.
Method Delete() (p. 290) Run the Delete action.
Method Duplicate() (p. 291) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
Ansys.ACT.Automation.Mechanical Namespace

Method ExportNastranFile(NastranExportOptions) (p. 291) Export Nastran File.


Method FilterBasedOnEnvironment() (p. 291) Enables interface filtering that only displays
model-level items applicable to the currently
selected environment type.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 291)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 292)
Method ImportLoad(Analysis) (p. 292) Import Load action.
Method OpenSolverFilesDirectory() (p. 292) Run the OpenSolverFilesDirectory action.
Method SelectBodiesWithMultiplePhysicsRegion() (p. 293) Run the SelectBodiesWithMultiplePhysicsRegion
action to select the bodies that belong to more tha
one Physics Region.
Method SelectBodiesWithoutPhysicsRegion() (p. 293) Run the SelectBodiesWithoutPhysicsRegion action
to select the bodies that don't belong to a Physics
Region.
Method Solve(bool) (p. 293) Run the Solve action.
Method Solve(bool, string) (p. 293) Run the Solve action.
Method TransferDataFrom(Analysis) (p. 294) Transfer Data From action.
Method UnlinkDataFrom(Analysis) (p. 294) Unlink Data From action.
Method WriteSystemCouplingFiles(string) (p. 294) Writes the system coupling files. Usage
WriteSystemCouplingFiles("C:\\Desktop\\temp\\scp

Acoustics
Gets or sets the Acoustics.

Declaration Syntax
public bool Acoustics { set;get; }

AMProcessSimulation
Gets or sets the AMProcessSimulation.

Declaration Syntax
public AMProcessSimulationType AMProcessSimulation { set;get; }

AnalysisSettings
Gets the AnalysisSettings.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public AnalysisSettings AnalysisSettings { get; }

AnalysisType
Gets the AnalysisType.

Declaration Syntax
public AnalysisType AnalysisType { get; }

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Electric
Gets the Electric.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 263
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Electric { get; }

EnvironmentTemperature
Gets or sets the EnvironmentTemperature.

Declaration Syntax
public Quantity EnvironmentTemperature { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerateInputOnly
Gets the GenerateInputOnly.

Declaration Syntax
public bool GenerateInputOnly { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InitialConditions
Get InitialConditions.

Declaration Syntax
public IList<InitialCondition> InitialConditions { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public IDSEnvironmentAuto InternalObject { get; }

PhysicsType
Gets the PhysicsType.

Declaration Syntax
public PhysicsType PhysicsType { get; }

ResultFileName
Get the full path and name of the result file.

Declaration Syntax
public string ResultFileName { get; }

Solution
Gets the Solution.

Declaration Syntax
public Solution Solution { get; }

Structural
Gets or sets the Structural.

Declaration Syntax
public bool Structural { set;get; }

SystemCaption
Gets the SystemCaption.

Declaration Syntax
public string SystemCaption { get; }

Thermal
Gets the Thermal.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 265
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Thermal { get; }

AddAcceleration()
Creates a new Acceleration

Declaration Syntax
public virtual Acceleration AddAcceleration()

AddAcousticAbsorptionElement()
Creates a new AcousticAbsorptionElement

Declaration Syntax
public virtual AcousticAbsorptionElement AddAcousticAbsorptionElement()

AddAcousticAbsorptionSurface()
Creates a new AcousticAbsorptionSurface

Declaration Syntax
public virtual AcousticAbsorptionSurface AddAcousticAbsorptionSurface()

AddAcousticDiffuseSoundField()
Creates a new AcousticDiffuseSoundField

Declaration Syntax
public virtual AcousticDiffuseSoundField AddAcousticDiffuseSoundField()

AddAcousticFarFieldRadationSurface()
Creates a new AcousticFarFieldRadationSurface

Declaration Syntax
public virtual AcousticFarFieldRadationSurface AddAcousticFarFieldRadationSurface()

AddAcousticFreeSurface()
Creates a new AcousticFreeSurface

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual AcousticFreeSurface AddAcousticFreeSurface()

AddAcousticImpedanceBoundary()
Creates a new AcousticImpedanceBoundary

Declaration Syntax
public virtual AcousticImpedanceBoundary AddAcousticImpedanceBoundary()

AddAcousticImpedanceSheet()
Creates a new AcousticImpedanceSheet

Declaration Syntax
public virtual AcousticImpedanceSheet AddAcousticImpedanceSheet()

AddAcousticIncidentWaveSource()
Creates a new AcousticIncidentWaveSource

Declaration Syntax
public virtual AcousticIncidentWaveSource AddAcousticIncidentWaveSource()

AddAcousticLowReducedFrequency()
Creates a new AcousticLowReducedFrequency

Declaration Syntax
public virtual AcousticLowReducedFrequency AddAcousticLowReducedFrequency()

AddAcousticMassSource()
Creates a new AcousticMassSource

Declaration Syntax
public virtual AcousticMassSource AddAcousticMassSource()

AddAcousticMassSourceRate()
Creates a new AcousticMassSourceRate

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 267
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AcousticMassSourceRate AddAcousticMassSourceRate()

AddAcousticPort()
Creates a new AcousticPort

Declaration Syntax
public virtual AcousticPort AddAcousticPort()

AddAcousticPortInDuct()
Creates a new AcousticPortInDuct

Declaration Syntax
public virtual AcousticPortInDuct AddAcousticPortInDuct()

AddAcousticPressure()
Creates a new AcousticPressure

Declaration Syntax
public virtual AcousticPressure AddAcousticPressure()

AddAcousticRadiationBoundary()
Creates a new AcousticRadiationBoundary

Declaration Syntax
public virtual AcousticRadiationBoundary AddAcousticRadiationBoundary()

AddAcousticRigidWall()
Creates a new AcousticRigidWall

Declaration Syntax
public virtual AcousticRigidWall AddAcousticRigidWall()

AddAcousticStaticPressure()
Creates a new AcousticStaticPressure

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual AcousticStaticPressure AddAcousticStaticPressure()

AddAcousticSurfaceAcceleration()
Creates a new AcousticSurfaceAcceleration

Declaration Syntax
public virtual AcousticSurfaceAcceleration AddAcousticSurfaceAcceleration()

AddAcousticSurfaceVelocity()
Creates a new AcousticSurfaceVelocity

Declaration Syntax
public virtual AcousticSurfaceVelocity AddAcousticSurfaceVelocity()

AddAcousticSymmetryPlane()
Creates a new AcousticSymmetryPlane

Declaration Syntax
public virtual AcousticSymmetryPlane AddAcousticSymmetryPlane()

AddAcousticTemperature()
Creates a new child ThermalCondition.

Declaration Syntax
public virtual AcousticTemperature AddAcousticTemperature()

AddAcousticThermoViscousBLIBoundary()
Creates a new AcousticThermoViscousBLIBoundary

Declaration Syntax
public virtual AcousticThermoViscousBLIBoundary AddAcousticThermoViscousBLIBoundary()

AddAcousticTransferAdmittanceMatrix()
Creates a new AcousticTransferAdmittanceMatrix

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 269
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AcousticTransferAdmittanceMatrix AddAcousticTransferAdmittanceMatrix()

AddAMOverhangConstraint()
Creates a new AMOverhangConstraint

Declaration Syntax
public virtual AMOverhangConstraint AddAMOverhangConstraint()

AddBearingLoad()
Creates a new BearingLoad

Declaration Syntax
public virtual BearingLoad AddBearingLoad()

AddBodyControl()
Creates a new BodyControl

Declaration Syntax
public virtual BodyControl AddBodyControl()

AddBoltPretension()
Creates a new BoltPretension

Declaration Syntax
public virtual BoltPretension AddBoltPretension()

AddCenterOfGravityConstraint()
Creates a new CenterOfGravityConstraint

Declaration Syntax
public virtual CenterOfGravityConstraint AddCenterOfGravityConstraint()

AddCommandSnippet()
Creates a new CommandSnippet

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddComplexityIndexConstraint()
Creates a new ComplexityIndexConstraint

Declaration Syntax
public virtual ComplexityIndexConstraint AddComplexityIndexConstraint()

AddComplianceConstraint()
Creates a new ComplianceConstraint

Declaration Syntax
public virtual ComplianceConstraint AddComplianceConstraint()

AddCompressionOnlySupport()
Creates a new CompressionOnlySupport

Declaration Syntax
public virtual CompressionOnlySupport AddCompressionOnlySupport()

AddConstraintEquation()
Creates a new ConstraintEquation

Declaration Syntax
public virtual ConstraintEquation AddConstraintEquation()

AddContactStepControl()
Creates a new ContactStepControl

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactStepControl AddContactStepControl()

AddConvection(DataRepresentation)
No details are provided for this entry.

Declaration Syntax
public virtual Convection AddConvection(DataRepresentation representation)

Parameters
representation(DataRepresentation)

Defines the return type of the both the Ambient Temperature and Convection Coefficient property
: For DataRepresentation.Field, the return object is a Field For DataRepresentation.Flexible the
return type is depends on the current configuration of the respective property: In constant mode,
it returns a quantity with the units corresponding to the property In tabular mode, it returns a
tabular data table In function mode, it returns a string containing the expression used to generate
the boundary condition data In table mode, it will return the table object that is currently assigned
to the load

AddCoupling()
Creates a new Coupling

Declaration Syntax
public virtual Coupling AddCoupling()

AddCriterionConstraint()
Creates a new CriterionConstraint

Declaration Syntax
public virtual CriterionConstraint AddCriterionConstraint()

AddCurrent()
Creates a new Current

Declaration Syntax
public virtual Current AddCurrent()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

AddCyclicManufacturingConstraint()
Creates a new CyclicManufacturingConstraint

Declaration Syntax
public virtual CyclicManufacturingConstraint AddCyclicManufacturingConstraint()

AddCylindricalSupport()
Creates a new CylindricalSupport

Declaration Syntax
public virtual CylindricalSupport AddCylindricalSupport()

AddDetonationPoint()
Creates a new DetonationPoint

Declaration Syntax
public virtual DetonationPoint AddDetonationPoint()

AddDisplacement()
Creates a new Displacement

Declaration Syntax
public virtual Displacement AddDisplacement()

AddDisplacementConstraint()
Creates a new DisplacementConstraint

Declaration Syntax
public virtual DisplacementConstraint AddDisplacementConstraint()

AddDynamicComplianceConstraint()
Creates a new DynamicComplianceConstraint

Declaration Syntax
public virtual DynamicComplianceConstraint AddDynamicComplianceConstraint()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
Ansys.ACT.Automation.Mechanical Namespace

AddEarthGravity()
Creates a new EarthGravity

Declaration Syntax
public virtual EarthGravity AddEarthGravity()

AddElasticSupport()
Creates a new ElasticSupport

Declaration Syntax
public virtual ElasticSupport AddElasticSupport()

AddElectricCharge()
Creates a new ElectricCharge

Declaration Syntax
public virtual ElectricCharge AddElectricCharge()

AddElementBirthAndDeath()
Creates a new ElementBirthAndDeath

Declaration Syntax
public virtual ElementBirthAndDeath AddElementBirthAndDeath()

AddEMTransducer()
Creates a new EMTransducer

Declaration Syntax
public virtual EMTransducer AddEMTransducer()

AddExtrusionManufacturingConstraint()
Creates a new ExtrusionManufacturingConstraint

Declaration Syntax
public virtual ExtrusionManufacturingConstraint AddExtrusionManufacturingConstraint()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddFixedRotation()
Creates a new FixedRotation

Declaration Syntax
public virtual FixedRotation AddFixedRotation()

AddFixedSupport()
Creates a new FixedSupport

Declaration Syntax
public virtual FixedSupport AddFixedSupport()

AddFluidPenetrationPressure()
Creates a new Fluid Penetration Pressure object in Mechanical. This load object is used to simulate
surrounding fluid or air penetrating into the contact interface. Users can apply this load to flexible-
to-flexible or rigid-to-flexible contact pairs. This load object is available for static structural analysis.

Declaration Syntax
public virtual FluidPenetrationPressure AddFluidPenetrationPressure()

AddFluidSolidInterface()
Creates a new FluidSolidInterface

Declaration Syntax
public virtual FluidSolidInterface AddFluidSolidInterface()

AddForce()
Creates a new Force

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 275
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Force AddForce()

AddFrictionlessSupport()
Creates a new FrictionlessSupport

Declaration Syntax
public virtual FrictionlessSupport AddFrictionlessSupport()

AddGeneralizedPlaneStrain()
Creates a new GeneralizedPlaneStrain

Declaration Syntax
public virtual GeneralizedPlaneStrain AddGeneralizedPlaneStrain()

AddGeometryBasedAdaptivity()
Creates a new GeometryBasedAdaptivity

Declaration Syntax
public virtual GeometryBasedAdaptivity AddGeometryBasedAdaptivity()

AddGlobalVonMisesStressConstraint()
Creates a new GlobalVonMisesStressConstraint

Declaration Syntax
public virtual GlobalVonMisesStressConstraint AddGlobalVonMisesStressConstraint()

AddHeatFlow()
Creates a new HeatFlow

Declaration Syntax
public virtual HeatFlow AddHeatFlow()

AddHeatFlux()
Creates a new HeatFlux

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual HeatFlux AddHeatFlux()

AddHousingConstraint()
Creates a new HousingConstraint

Declaration Syntax
public virtual HousingConstraint AddHousingConstraint()

AddHydrostaticPressure()
Creates a new HydrostaticPressure

Declaration Syntax
public virtual HydrostaticPressure AddHydrostaticPressure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImpedanceBoundary()
Creates a new ImpedanceBoundary

Declaration Syntax
public virtual ImpedanceBoundary AddImpedanceBoundary()

AddImportedCFDPressure()
Creates a new ImportedCFDPressure

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ImportedCFDPressure AddImportedCFDPressure()

AddImportedLoadExternalData()
Creates a new Imported Load (External Data).

Declaration Syntax
public virtual ImportedLoadGroup AddImportedLoadExternalData()

AddImportedLoadFluidsResultsFile()
Creates a new Import Load for Fluids Results File.

Declaration Syntax
public virtual ImportedLoadGroup AddImportedLoadFluidsResultsFile()

AddImportedLoadMAPDLResultsFile()
Creates a new Import Load for MAPDL Results File.

Declaration Syntax
public virtual ImportedLoadGroup AddImportedLoadMAPDLResultsFile()

AddImportedRemoteLoadsGroup()
Creates a new Import Remote Load Group.

Declaration Syntax
public virtual LoadGroup AddImportedRemoteLoadsGroup()

AddInitialVelocity()
Creates a new child Initial Velocity.

Declaration Syntax
public virtual InitialCondition AddInitialVelocity()

AddInternalHeatGeneration()
Creates a new InternalHeatGeneration

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual InternalHeatGeneration AddInternalHeatGeneration()

AddJointLoad()
Creates a new JointLoad

Declaration Syntax
public virtual JointLoad AddJointLoad()

AddLimitBoundary()
Creates a new LimitBoundary

Declaration Syntax
public virtual LimitBoundary AddLimitBoundary()

AddLinePressure()
Creates a new LinePressure

Declaration Syntax
public virtual LinePressure AddLinePressure()

AddLocalVonMisesStressConstraint()
Creates a new LocalVonMisesStressConstraint

Declaration Syntax
public virtual LocalVonMisesStressConstraint AddLocalVonMisesStressConstraint()

AddMagneticFluxParallel()
Creates a new MagneticFluxParallel

Declaration Syntax
public virtual MagneticFluxParallel AddMagneticFluxParallel()

AddMassConstraint()
Creates a new MassConstraint

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual MassConstraint AddMassConstraint()

AddMassFlowRate()
Creates a new MassFlowRate

Declaration Syntax
public virtual MassFlowRate AddMassFlowRate()

AddMemberSizeManufacturingConstraint()
Creates a new MemberSizeManufacturingConstraint

Declaration Syntax
public virtual MemberSizeManufacturingConstraint AddMemberSizeManufacturingConstraint()

AddMoment()
Creates a new Moment

Declaration Syntax
public virtual Moment AddMoment()

AddMomentOfInertiaConstraint()
Creates a new MomentOfInertiaConstraint

Declaration Syntax
public virtual MomentOfInertiaConstraint AddMomentOfInertiaConstraint()

AddMorphingRegion()
Creates a new MorphingRegion

Declaration Syntax
public virtual MorphingRegion AddMorphingRegion()

AddNaturalFrequencyConstraint()
Creates a new NaturalFrequencyConstraint

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual NaturalFrequencyConstraint AddNaturalFrequencyConstraint()

AddNodalDisplacement()
Creates a new NodalDisplacement

Declaration Syntax
public virtual NodalDisplacement AddNodalDisplacement()

AddNodalForce()
Creates a new NodalForce

Declaration Syntax
public virtual NodalForce AddNodalForce()

AddNodalOrientation()
Creates a new NodalOrientation

Declaration Syntax
public virtual NodalOrientation AddNodalOrientation()

AddNodalPressure()
Creates a new NodalPressure

Declaration Syntax
public virtual NodalPressure AddNodalPressure()

AddNodalRotation()
Creates a new NodalRotation

Declaration Syntax
public virtual NodalRotation AddNodalRotation()

AddNonlinearAdaptiveRegion()
Creates a new NonlinearAdaptiveRegion

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual NonlinearAdaptiveRegion AddNonlinearAdaptiveRegion()

AddObjective()
Creates a new Objective

Declaration Syntax
public virtual Objective AddObjective()

AddOptimizationRegion()
Creates a new OptimizationRegion

Declaration Syntax
public virtual OptimizationRegion AddOptimizationRegion()

AddPatternRepetitionConstraint()
Creates a new PatternRepetitionConstraint

Declaration Syntax
public virtual PatternRepetitionConstraint AddPatternRepetitionConstraint()

AddPerfectlyInsulated()
Creates a new PerfectlyInsulated

Declaration Syntax
public virtual PerfectlyInsulated AddPerfectlyInsulated()

AddPhysicsRegion()
Creates a new PhysicsRegion

Declaration Syntax
public virtual PhysicsRegion AddPhysicsRegion()

AddPipeIdealization()
Creates a new child PipeIdealization.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual PipeIdealization AddPipeIdealization()

AddPipePressure()
Creates a new PipePressure

Declaration Syntax
public virtual PipePressure AddPipePressure()

AddPipeTemperature()
Creates a new PipeTemperature

Declaration Syntax
public virtual PipeTemperature AddPipeTemperature()

AddPlasticHeating()
Creates a new PlasticHeating

Declaration Syntax
public virtual PlasticHeating AddPlasticHeating()

AddPressure(DataRepresentation)
Creates a new child Pressure. DataRepresentation.Field will use the Field object for working with
tabular data DataRepresentation.Flexible allows the use of the following types when the pressure is
defined as a normal to a surface: Quantity: The unit must be a valid Pressure unit string: It is interpreted
as s table if it matches a Table name. Else it is interpreted as an expresion Table: A table object can
be specified.

Declaration Syntax
public virtual Pressure AddPressure(DataRepresentation representation)

Parameters
representation(DataRepresentation)

No details are provided for this entry.

AddPSDAcceleration()
Creates a new PSDAcceleration

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual PSDAcceleration AddPSDAcceleration()

AddPSDDisplacement()
Creates a new PSDDisplacement

Declaration Syntax
public virtual PSDDisplacement AddPSDDisplacement()

AddPSDGAcceleration()
Creates a new PSDGAcceleration

Declaration Syntax
public virtual PSDGAcceleration AddPSDGAcceleration()

AddPSDVelocity()
Creates a new PSDVelocity

Declaration Syntax
public virtual PSDVelocity AddPSDVelocity()

AddPullOutDirectionManufacturingConstraint()
Creates a new PullOutDirectionManufacturingConstraint

Declaration Syntax
public virtual PullOutDirectionManufacturingConstraint AddPullOutDirectionManufacturingConstraint()

AddPythonCodeEventBased()
Creates a new PythonCodeEventBased

Declaration Syntax
public virtual PythonCodeEventBased AddPythonCodeEventBased()

AddRadiation()
Creates a new Radiation

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual Radiation AddRadiation()

AddReactionForceConstraint()
Creates a new ReactionForceConstraint

Declaration Syntax
public virtual ReactionForceConstraint AddReactionForceConstraint()

AddRemoteDisplacement()
Creates a new RemoteDisplacement

Declaration Syntax
public virtual RemoteDisplacement AddRemoteDisplacement()

AddRemoteForce()
Creates a new RemoteForce

Declaration Syntax
public virtual RemoteForce AddRemoteForce()

AddRotatingForce()
Creates a new RotatingForce

Declaration Syntax
public virtual RotatingForce AddRotatingForce()

AddRotationalAcceleration()
Creates a new RotationalAcceleration

Declaration Syntax
public virtual RotationalAcceleration AddRotationalAcceleration()

AddRotationalVelocity()
Creates a new RotationalVelocity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual RotationalVelocity AddRotationalVelocity()

AddRSAcceleration()
Creates a new RSAcceleration

Declaration Syntax
public virtual RSAcceleration AddRSAcceleration()

AddRSDisplacement()
Creates a new RSDisplacement

Declaration Syntax
public virtual RSDisplacement AddRSDisplacement()

AddRSVelocity()
Creates a new RSVelocity

Declaration Syntax
public virtual RSVelocity AddRSVelocity()

AddSimplySupported()
Creates a new SimplySupported

Declaration Syntax
public virtual SimplySupported AddSimplySupported()

AddSourceConductor()
Creates a new child SourceConductor.

Declaration Syntax
public virtual LoadGroup AddSourceConductor()

AddSubstructureGenerationCondensedPart()
Creates a new SubstructureGenerationCondensedPart

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual SubstructureGenerationCondensedPart AddSubstructureGenerationCondensedPart()

AddSurfaceChargeDensity()
Creates a new SurfaceChargeDensity

Declaration Syntax
public virtual SurfaceChargeDensity AddSurfaceChargeDensity()

AddSymmetryManufacturingConstraint()
Creates a new SymmetryManufacturingConstraint

Declaration Syntax
public virtual SymmetryManufacturingConstraint AddSymmetryManufacturingConstraint()

AddSystemCouplingRegion()
Creates a new SystemCouplingRegion

Declaration Syntax
public virtual FluidSolidInterface AddSystemCouplingRegion()

AddTemperature(DataRepresentation)
Creates a new child Temperature.

Declaration Syntax
public virtual Temperature AddTemperature(DataRepresentation representation)

Parameters
representation(DataRepresentation)

Defines the return type of the Magnitude property : For DataRepresentation.Field, the return object
is a Field For DataRepresentation.Flexible the return type is depends on the current configuration
of the Magnitude property: In constant mode, it returns a quantity In tabular mode, it returns a
tabular data table In function mode, it returns a string containing the expression used to generate
the boundary condition data In table mode, it will return the table object that is currently assigned
to the load

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
Ansys.ACT.Automation.Mechanical Namespace

AddTemperatureConstraint()
Creates a new TemperatureConstraint

Declaration Syntax
public virtual TemperatureConstraint AddTemperatureConstraint()

AddThermalComplianceConstraint()
Creates a new ThermalComplianceConstraint

Declaration Syntax
public virtual ThermalComplianceConstraint AddThermalComplianceConstraint()

AddThermalCondition()
Creates a new child ThermalCondition.

Declaration Syntax
public virtual ThermalCondition AddThermalCondition()

AddThermalCondition(DataRepresentation)
No details are provided for this entry.

Declaration Syntax
public virtual ThermalCondition AddThermalCondition(DataRepresentation representation)

Parameters
representation(DataRepresentation)

Defines the return type of the both the Magnitude property : For DataRepresentation.Field, the
return object is a Field For DataRepresentation.Flexible the return type is depends on the current
configuration of the Magnitude property: In constant mode, it returns a quantity In tabular mode,
it returns a tabular data table In function mode, it returns a string containing the expression used
to generate the boundary condition data In table mode, it will return the table object that is
currently assigned to the load

AddUniformConstraint()
Creates a new UniformConstraint

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual UniformConstraint AddUniformConstraint()

AddVelocity()
Creates a new Velocity

Declaration Syntax
public virtual Velocity AddVelocity()

AddViscoelasticHeating()
Creates a new ViscoelasticHeating

Declaration Syntax
public virtual ViscoelasticHeating AddViscoelasticHeating()

AddVoltage()
Creates a new Voltage

Declaration Syntax
public virtual Voltage AddVoltage()

AddVoltageCoupling()
Creates a new Coupling

Declaration Syntax
public virtual Coupling AddVoltageCoupling()

AddVoltageGround()
Creates a new VoltageGround

Declaration Syntax
public virtual VoltageGround AddVoltageGround()

AddVolumeChargeDensity()
Creates a new VolumeChargeDensity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual VolumeChargeDensity AddVolumeChargeDensity()

AddVolumeConstraint()
Creates a new VolumeConstraint

Declaration Syntax
public virtual VolumeConstraint AddVolumeConstraint()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateAutomaticFarFieldRadiationSurfaces()
Run the CreateAutomaticEquivalentSourceSurfaces action.

Declaration Syntax
public virtual void CreateAutomaticFarFieldRadiationSurfaces()

CreateAutomaticFSI()
Run the CreateAutomaticFSI action.

Declaration Syntax
public virtual void CreateAutomaticFSI()

CreateAutomaticFSIandFarFieldRadiationSurfaces()
Run the CreateAutomaticFSIandEquivalentSourceSurfaces action.

Declaration Syntax
public virtual void CreateAutomaticFSIandFarFieldRadiationSurfaces()

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

Declaration Syntax
public virtual void Delete()

Duplicate()
No details are provided for this entry.

Declaration Syntax
public override IDataModelObject Duplicate()

ExportNastranFile(NastranExportOptions)
Export Nastran File.

Declaration Syntax
public virtual void ExportNastranFile(NastranExportOptions exportOptions)

Parameters
exportOptions(NastranExportOptions)

Export options.

FilterBasedOnEnvironment()
Enables interface filtering that only displays model-level items applicable to the currently selected
environment type.

Declaration Syntax
public virtual void FilterBasedOnEnvironment()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
Ansys.ACT.Automation.Mechanical Namespace

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ImportLoad(Analysis)
Import Load action.

Declaration Syntax
public virtual void ImportLoad(Analysis analysis)

Parameters
analysis(Analysis)

Analysis system.

OpenSolverFilesDirectory()
Run the OpenSolverFilesDirectory action.

Declaration Syntax
public virtual void OpenSolverFilesDirectory()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
Analysis

SelectBodiesWithMultiplePhysicsRegion()
Run the SelectBodiesWithMultiplePhysicsRegion action to select the bodies that belong to more than
one Physics Region.

Declaration Syntax
public virtual void SelectBodiesWithMultiplePhysicsRegion()

SelectBodiesWithoutPhysicsRegion()
Run the SelectBodiesWithoutPhysicsRegion action to select the bodies that don't belong to a Physics
Region.

Declaration Syntax
public virtual void SelectBodiesWithoutPhysicsRegion()

Solve(bool)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait)

Parameters
wait(bool)

Wait or not for the solve to be done.

Solve(bool, string)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, string config)

Parameters
wait(bool)

Wait or not for the solve to be done.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
Ansys.ACT.Automation.Mechanical Namespace

config(string)

The solve configuration to use. Will throw an error if the input solve configuration does not exist.
If none is provided, the default is used for the solve.

TransferDataFrom(Analysis)
Transfer Data From action.

Declaration Syntax
public virtual void TransferDataFrom(Analysis analysis)

Parameters
analysis(Analysis)

Analysis system.

UnlinkDataFrom(Analysis)
Unlink Data From action.

Declaration Syntax
public virtual void UnlinkDataFrom(Analysis analysis)

Parameters
analysis(Analysis)

Analysis system.

WriteSystemCouplingFiles(string)
Writes the system coupling files. Usage WriteSystemCouplingFiles("C:\\Desktop\\temp\\scp1.scp");

Declaration Syntax
public virtual void WriteSystemCouplingFiles(string filename)

Parameters
filename(string)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
AnalysisPly

AnalysisPly
Defines a AnalysisPly.

Declaration Syntax
public class AnalysisPly : ImportedDataModelObject, IFolderDataModelObject

Table 161: Members

Property Angle (p. 295) Gets or sets the Angle.


Property Children (p. 295) Gets the list of children.
Property Comments (p. 296) Gets the list of associated comments.
Property DataModelObjectCategory (p. 296) Gets the current DataModelObject's category.
Property Figures (p. 296) Gets the list of associated figures.
Property IDInSource (p. 296) Gets the IDInSource.
Property Images (p. 296) Gets the list of associated images.
Property InternalObject (p. 296) Gets the internal object. For advanced usage only.
Property Material (p. 297) Gets the Material.
Property NameInSource (p. 297) Gets the NameInSource.
Property NumberOfElements (p. 297) Gets the NumberOfElements.
Property Thickness (p. 297) Gets the Thickness.
Method AddComment() (p. 297) Creates a new child Comment.
Method AddFigure() (p. 297) Creates a new child Figure.
Method AddImage(string) (p. 298) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 298)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 298)

Angle
Gets or sets the Angle.

Declaration Syntax
public Quantity Angle { set;get; }

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 295
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

IDInSource
Gets the IDInSource.

Declaration Syntax
public string IDInSource { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
AnalysisPly

Declaration Syntax
public IDSAnalysisPlyAuto InternalObject { get; }

Material
Gets the Material.

Declaration Syntax
public string Material { get; }

NameInSource
Gets the NameInSource.

Declaration Syntax
public string NameInSource { get; }

NumberOfElements
Gets the NumberOfElements.

Declaration Syntax
public uint NumberOfElements { get; }

Thickness
Gets the Thickness.

Declaration Syntax
public Quantity Thickness { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
ArbitraryCrack

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ArbitraryCrack
Defines a ArbitraryCrack.

Declaration Syntax
public class ArbitraryCrack : GenericCrack

Table 162: Members

Property BottomFaceNodes (p. 300) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 300) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 300) Gets or sets the Contact1Nodes named selection
name.
Property ContactPairsNodes (p. 301) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 301) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 301) Gets or sets the CrackFacesNodes.
Property CrackFrontNodes (p. 301) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 301) Gets the CrackMeshMethod.
Property CrackShape (p. 301) Gets the CrackShape.
Property CrackSourceType (p. 302) Gets the CrackSourceType.
Property CrackSurfaceLocation (p. 302) Gets or sets the CrackSurfaceLocation.
Property DataModelObjectCategory (p. 302) Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
Ansys.ACT.Automation.Mechanical Namespace

Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FrontElementSize (p. 302) Gets or sets the FrontElementSize.
Property GrowthRate (p. 302) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 302) Gets the internal object. For advanced usage only.
Property LargestContourRadius (p. 303) Gets or sets the LargestContourRadius.
Property Location (p. 303) Gets or sets the Location.
Property MeshContours (p. 303) Gets or sets the MeshContours.
Property SolutionContours (p. 303) Gets or sets the SolutionContours.
Property Suppressed (p. 303) Gets or sets the Suppressed.
Property Target1Nodes (p. 303) Gets or sets the Target1Nodes named selection
name.
Property TopFaceNodes (p. 304) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 304) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 304) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 304) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes named selection name.

Declaration Syntax
public string Contact1Nodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
ArbitraryCrack

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
Ansys.ACT.Automation.Mechanical Namespace

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

CrackSurfaceLocation
Gets or sets the CrackSurfaceLocation.

Declaration Syntax
public ISelectionInfo CrackSurfaceLocation { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
ArbitraryCrack

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes named selection name.

Declaration Syntax
public string Target1Nodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
Ansys.ACT.Automation.Mechanical Namespace

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

ArchiveSettings
A settings class for the project Archive operation

Declaration Syntax
public class ArchiveSettings

Table 163: Members

Constructor ArchiveSettings(bool, bool) (p. 305) A settings class for the project Archive operation
Property IncludeResultAndSolutionFiles (p. 305) A boolean which configures the option to include
result/solution files in the archive file
Property IncludeUserFiles (p. 305) A boolean which configures the option to include
files inside the UserFiles folder in the archive file

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
BatchConnectionsWorksheet

ArchiveSettings(bool, bool)
A settings class for the project Archive operation

Declaration Syntax
public ArchiveSettings(bool includeResultAndSolutionFiles, bool includeUserFiles)

Parameters
includeResultAndSolutionFiles(bool)

Optional argument to include result/solution files in the archive file. Default is true.

includeUserFiles(bool)

Optional argument to include files inside the UserFiles folder in the archive file. Default is true.

IncludeResultAndSolutionFiles
A boolean which configures the option to include result/solution files in the archive file

Declaration Syntax
public bool IncludeResultAndSolutionFiles { set;get; }

IncludeUserFiles
A boolean which configures the option to include files inside the UserFiles folder in the archive file

Declaration Syntax
public bool IncludeUserFiles { set;get; }

BatchConnectionsWorksheet
No details are provided for this entry.

Declaration Syntax
public class BatchConnectionsWorksheet : Worksheet

Table 164: Members

Property RowCount (p. 306) Gets the number of entries


Method AddRow() (p. 306) Add a row to the MeshControlWorksheet
Method ClearGenerateMesh() (p. 306) Clear Mesh
Method DeleteAllRows() (p. 307) Delete All Rows

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
Ansys.ACT.Automation.Mechanical Namespace

Method DeleteRow(int) (p. 307) Delete a row from the MeshControlWorksheet


Method GenerateAtRow(int) (p. 307) Generate Mesh At Row
Method GenerateMesh() (p. 307) Geneate Mesh
Method GetActiveState(int) (p. 307) Gets the Active State property at row index
Method GetConnectionOption(int) (p. 308) Gets the current set cconnection option at
the row index
Method GetConnectionTolerances(int) (p. 308) Gets the list of connection tolerances at the
row index
Method GetNamedSelection(int) (p. 308) Gets the NamedSelection at row index
Method GetNamedSelectionId(int) (p. 309) Gets the ID of the NamedSelection at row
index
Method SetActiveState(int, bool) (p. 309) Sets the Active State property at row index
Method SetConnectionOption(int, int) (p. 309) Sets the connection option at row index
Method SetConnectionTolerances(int, string) (p. 310) Sets the connection tolerance list at row
index
Method SetNamedSelection(int, Sets the NamedSelection at row index
NamedSelection) (p. 310)
Method SetNamedSelectionId(int, uint) (p. 310) Sets the NamedSelection by ID at row index

RowCount
Gets the number of entries

Declaration Syntax
public int RowCount { get; }

AddRow()
Add a row to the MeshControlWorksheet

Declaration Syntax
public override int AddRow()

ClearGenerateMesh()
Clear Mesh

Declaration Syntax
public virtual void ClearGenerateMesh()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
BatchConnectionsWorksheet

DeleteAllRows()
Delete All Rows

Declaration Syntax
public virtual void DeleteAllRows()

DeleteRow(int)
Delete a row from the MeshControlWorksheet

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)

No details are provided for this entry.

GenerateAtRow(int)
Generate Mesh At Row

Declaration Syntax
public virtual void GenerateAtRow(int index)

Parameters
index(int)

No details are provided for this entry.

GenerateMesh()
Geneate Mesh

Declaration Syntax
public virtual void GenerateMesh()

GetActiveState(int)
Gets the Active State property at row index

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual bool GetActiveState(int index)

Parameters
index(int)

No details are provided for this entry.

GetConnectionOption(int)
Gets the current set cconnection option at the row index

Declaration Syntax
public virtual int GetConnectionOption(int index)

Parameters
index(int)

No details are provided for this entry.

GetConnectionTolerances(int)
Gets the list of connection tolerances at the row index

Declaration Syntax
public virtual string GetConnectionTolerances(int index)

Parameters
index(int)

No details are provided for this entry.

GetNamedSelection(int)
Gets the NamedSelection at row index

Declaration Syntax
public virtual NamedSelection GetNamedSelection(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
BatchConnectionsWorksheet

Parameters
index(int)

No details are provided for this entry.

GetNamedSelectionId(int)
Gets the ID of the NamedSelection at row index

Declaration Syntax
public virtual uint GetNamedSelectionId(int index)

Parameters
index(int)

No details are provided for this entry.

SetActiveState(int, bool)
Sets the Active State property at row index

Declaration Syntax
public virtual void SetActiveState(int index, bool value)

Parameters
index(int)

No details are provided for this entry.

value(bool)

No details are provided for this entry.

SetConnectionOption(int, int)
Sets the connection option at row index

Declaration Syntax
public virtual void SetConnectionOption(int index, int value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

No details are provided for this entry.

value(int)

No details are provided for this entry.

SetConnectionTolerances(int, string)
Sets the connection tolerance list at row index

Declaration Syntax
public virtual void SetConnectionTolerances(int index, string value)

Parameters
index(int)

No details are provided for this entry.

value(string)

No details are provided for this entry.

SetNamedSelection(int, NamedSelection)
Sets the NamedSelection at row index

Declaration Syntax
public virtual void SetNamedSelection(int index, NamedSelection value)

Parameters
index(int)

No details are provided for this entry.

value(NamedSelection)

No details are provided for this entry.

SetNamedSelectionId(int, uint)
Sets the NamedSelection by ID at row index

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public virtual void SetNamedSelectionId(int index, uint value)

Parameters
index(int)

No details are provided for this entry.

value(uint)

No details are provided for this entry.

Body
Defines a Body.

Declaration Syntax
public class Body : ImportedDataModelObject, IFolderDataModelObject

Table 165: Members

Property Assignment ***OBSOLETE*** Use Gets or sets the Assignment.


'Material' property instead. (p. 314)
Property Average (p. 314) Gets the Average.
Property BeamSection (p. 314) Gets the BeamSection.
Property Behavior (p. 314) Gets or sets the Behavior.
Property BrickIntegrationScheme (p. 314) Gets or sets the BrickIntegrationScheme.
Property CentroidX (p. 315) Gets the CentroidX.
Property CentroidY (p. 315) Gets the CentroidY.
Property CentroidZ (p. 315) Gets the CentroidZ.
Property Children (p. 315) Gets the list of children.
Property Color (p. 315) Gets or sets the Color, encoded as a BGR bitfield.
Property Comments (p. 315) Gets the list of associated comments.
Property ConfigurationId (p. 316) Gets the related Result Mesh's ConfigurationId.
Property CoordinateSystem (p. 316) Gets or sets the CoordinateSystem.
Property CrossSectionArea (p. 316) Gets the CrossSectionArea.
Property CrossSectionIYY (p. 316) Gets the CrossSectionIYY.
Property CrossSectionIZZ (p. 316) Gets the CrossSectionIZZ.
Property CrossSectionName (p. 316) Gets CrossSectionName.
Property CrossSectionSelection (p. 317) Gets or sets the CrossSectionSelection.
Property DataModelObjectCategory (p. 317) Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 311
Ansys.ACT.Automation.Mechanical Namespace

Property Dimension (p. 317) Gets or sets the Dimension.


Property Elements (p. 317) Gets the Elements.
Property FiberAngle (p. 317) Gets or sets the FiberAngle.
Property FiberCrossSectionArea (p. 317) Gets or sets the FiberCrossSectionArea.
Property FiberSpacing (p. 318) Gets or sets the FiberSpacing.
Property Figures (p. 318) Gets the list of associated figures.
Property FluidCrossArea (p. 318) Gets or sets the FluidCrossArea.
Property FluidDiscretization (p. 318) Gets or sets the FluidDiscretization.
Property FluidSolidPhase (p. 318) Gets or sets the FluidSolidPhase.
Property GeometryType (p. 318) Gets the GeometryType.
Property Hidden (p. 319) Hide or show the body.
Property HomogeneousMembrane (p. 319) Gets or sets the HomogeneousMembrane.
Property Images (p. 319) Gets the list of associated images.
Property InternalObject (p. 319) Gets the internal object. For advanced usage only.
Property IsWindingBody (p. 319) Gets the IsWindingBody.
Property Length (p. 319) Gets the Length.
Property LengthX (p. 320) Gets the LengthX.
Property LengthY (p. 320) Gets the LengthY.
Property LengthZ (p. 320) Gets the LengthZ.
Property LinkTrussBehavior (p. 320) Gets or sets the LinkTrussBehavior.
Property ManualThicknessMode (p. 320) Gets the ManualThicknessMode.
Property Mass (p. 320) Gets the Mass.
Property Material (p. 321) Gets or sets the Material.
Property MaterialPolarizationDirection (p. 321) Gets or sets the MaterialPolarizationDirection.
Property Maximum (p. 321) Gets the Maximum.
Property MeshMetric (p. 321) Gets the MeshMetric.
Property MeshVersion (p. 321) Gets the MeshVersion.
Property Minimum (p. 321) Gets the Minimum.
Property ModelType (p. 322) Gets or sets the ModelType. Note: ModelType is
applicable to line bodies and surface bodies only.
Property MomentOfInertiaIp1 (p. 322) Gets the MomentOfInertiaIp1.
Property MomentOfInertiaIp2 (p. 322) Gets the MomentOfInertiaIp2.
Property MomentOfInertiaIp3 (p. 322) Gets the MomentOfInertiaIp3.
Property Nodes (p. 322) Gets the Nodes.
Property NonlinearEffects (p. 322) Gets or sets the NonlinearEffects.
Property NumberOfTurns (p. 323) Gets or sets the NumberOfTurns.
Property OffsetMode (p. 323) Gets or sets the OffsetMode.
Property OffsetType (p. 323) Gets or sets the OffsetType.
Property OffsetX (p. 323) Gets or sets the OffsetX.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
312 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Property OffsetY (p. 323) Gets or sets the OffsetY.


Property PipeExternalDiameter (p. 323) Gets the PipeExternalDiameter.
Property PipeInternalDiameter (p. 324) Gets the PipeInternalDiameter.
Property PipeThickness (p. 324) Gets the PipeThickness.
Property ReferenceFrame (p. 324) Gets or sets the ReferenceFrame.
Property ReferenceTemperature ***OBSOLETE*** Gets or sets the ReferenceTemperature.
Use 'UseReferenceTemperatureByBody'
property instead. (p. 324)
Property ReferenceTemperatureValue (p. 324) Gets or sets the ReferenceTemperatureValue.
Property ReinforcingStressState (p. 324) Gets or sets the ReinforcingStressState.
Property ResultMeshId (p. 325) Gets the related Result Mesh's ObjectId.
Property ShellOffsetType (p. 325) Gets or sets the ShellOffsetType.
Property StandardDeviation (p. 325) Gets the StandardDeviation.
Property StiffnessBehavior (p. 325) Gets or sets the StiffnessBehavior.
Property StiffnessOption (p. 325) Gets or sets the StiffnessOption.
Property Suppressed (p. 325) Gets or sets the Suppressed.
Property SuppressedParameterized (p. 326) Gets if the part suppressed property is
parameterized.
Property SurfaceArea (p. 326) Gets the SurfaceArea.
Property ThermalStrainEffects (p. 326) Gets or sets the ThermalStrainEffects.
Property Thickness (p. 326) Gets or sets the Thickness.
Property ThicknessMode ***OBSOLETE*** Use Gets the ThicknessMode.
'ManualThicknessMode' property
instead. (p. 326)
Property Transparency (p. 326) Gets or sets the Transparency. Values range from
0.0 (fully invisible) to 1.0 (fully visible).
Property Treatment (p. 327) Gets or sets the Treatment.
Property UseReferenceTemperatureByBody (p. 327) Gets or sets the UseReferenceTemperatureByBody.
Property UserNameChange (p. 327) Gets the UserNameChange.
Property Visible (p. 327) Gets or sets the Visible.
Property Volume (p. 327) Gets the Volume.
Method AddCommandSnippet() (p. 327) Creates a new CommandSnippet
Method AddComment() (p. 328) Creates a new child Comment.
Method AddFigure() (p. 328) Creates a new child Figure.
Method AddImage(string) (p. 328) Creates a new child Image. If a filePath is
provided, the image will be loaded from that file,
if not, the image will be a screen capture of the
Geometry window.
Method AddPythonCodeEventBased() (p. 328) Creates a new PythonCodeEventBased
Method ClearGeneratedData() (p. 328) Run the ClearGeneratedData action.
Method GenerateMesh() (p. 329) Run the GenerateMesh action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.


IList<ChildrenType>) (p. 329)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 329)
Method GetGeoBody() (p. 330) Gets the Geo Body
Method PreviewInflation() (p. 330) Run the PreviewInflation action.
Method PreviewSurfaceMesh() (p. 330) Run the PreviewSurfaceMesh action.
Method ShowBody() (p. 330) Run the ShowBody action.
Method Update() (p. 330) Run the Update action.

Assignment ***OBSOLETE*** Use 'Material' property instead.


Gets or sets the Assignment.

Declaration Syntax
public string Assignment { set;get; }

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

BeamSection
Gets the BeamSection.

Declaration Syntax
public DataModelObject BeamSection { get; }

Behavior
Gets or sets the Behavior.

Declaration Syntax
public Model2DBehavior Behavior { set;get; }

BrickIntegrationScheme
Gets or sets the BrickIntegrationScheme.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public BrickIntegrationScheme BrickIntegrationScheme { set;get; }

CentroidX
Gets the CentroidX.

Declaration Syntax
public Quantity CentroidX { get; }

CentroidY
Gets the CentroidY.

Declaration Syntax
public Quantity CentroidY { get; }

CentroidZ
Gets the CentroidZ.

Declaration Syntax
public Quantity CentroidZ { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Color
Gets or sets the Color, encoded as a BGR bitfield.

Declaration Syntax
public uint Color { set;get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ConfigurationId
Gets the related Result Mesh's ConfigurationId.

Declaration Syntax
public int ConfigurationId { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrossSectionArea
Gets the CrossSectionArea.

Declaration Syntax
public Quantity CrossSectionArea { get; }

CrossSectionIYY
Gets the CrossSectionIYY.

Declaration Syntax
public Quantity CrossSectionIYY { get; }

CrossSectionIZZ
Gets the CrossSectionIZZ.

Declaration Syntax
public Quantity CrossSectionIZZ { get; }

CrossSectionName
Gets CrossSectionName.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public string CrossSectionName { get; }

CrossSectionSelection
Gets or sets the CrossSectionSelection.

Declaration Syntax
public CrossSection CrossSectionSelection { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Dimension
Gets or sets the Dimension.

Declaration Syntax
public ShellBodyDimension Dimension { set;get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

FiberAngle
Gets or sets the FiberAngle.

Declaration Syntax
public Quantity FiberAngle { set;get; }

FiberCrossSectionArea
Gets or sets the FiberCrossSectionArea.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity FiberCrossSectionArea { set;get; }

FiberSpacing
Gets or sets the FiberSpacing.

Declaration Syntax
public Quantity FiberSpacing { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FluidCrossArea
Gets or sets the FluidCrossArea.

Declaration Syntax
public Quantity FluidCrossArea { set;get; }

FluidDiscretization
Gets or sets the FluidDiscretization.

Declaration Syntax
public FluidDiscretizationType FluidDiscretization { set;get; }

FluidSolidPhase
Gets or sets the FluidSolidPhase.

Declaration Syntax
public PhaseType FluidSolidPhase { set;get; }

GeometryType
Gets the GeometryType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public GeometryType GeometryType { get; }

Hidden
Hide or show the body.

Declaration Syntax
public bool Hidden { set;get; }

HomogeneousMembrane
Gets or sets the HomogeneousMembrane.

Declaration Syntax
public bool HomogeneousMembrane { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPrototypeAuto InternalObject { get; }

IsWindingBody
Gets the IsWindingBody.

Declaration Syntax
public bool IsWindingBody { get; }

Length
Gets the Length.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity Length { get; }

LengthX
Gets the LengthX.

Declaration Syntax
public Quantity LengthX { get; }

LengthY
Gets the LengthY.

Declaration Syntax
public Quantity LengthY { get; }

LengthZ
Gets the LengthZ.

Declaration Syntax
public Quantity LengthZ { get; }

LinkTrussBehavior
Gets or sets the LinkTrussBehavior.

Declaration Syntax
public PrototypeLinkBehavior LinkTrussBehavior { set;get; }

ManualThicknessMode
Gets the ManualThicknessMode.

Declaration Syntax
public bool ManualThicknessMode { get; }

Mass
Gets the Mass.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public Quantity Mass { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaterialPolarizationDirection
Gets or sets the MaterialPolarizationDirection.

Declaration Syntax
public MaterialPolarizationDirection MaterialPolarizationDirection { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

MeshMetric
Gets the MeshMetric.

Declaration Syntax
public MeshMetricType MeshMetric { get; }

MeshVersion
Gets the MeshVersion.

Declaration Syntax
public int MeshVersion { get; }

Minimum
Gets the Minimum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 321
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity Minimum { get; }

ModelType
Gets or sets the ModelType. Note: ModelType is applicable to line bodies and surface bodies only.

Declaration Syntax
public PrototypeModelType ModelType { set;get; }

MomentOfInertiaIp1
Gets the MomentOfInertiaIp1.

Declaration Syntax
public Quantity MomentOfInertiaIp1 { get; }

MomentOfInertiaIp2
Gets the MomentOfInertiaIp2.

Declaration Syntax
public Quantity MomentOfInertiaIp2 { get; }

MomentOfInertiaIp3
Gets the MomentOfInertiaIp3.

Declaration Syntax
public Quantity MomentOfInertiaIp3 { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

NonlinearEffects
Gets or sets the NonlinearEffects.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public bool NonlinearEffects { set;get; }

NumberOfTurns
Gets or sets the NumberOfTurns.

Declaration Syntax
public uint NumberOfTurns { set;get; }

OffsetMode
Gets or sets the OffsetMode.

Declaration Syntax
public AutomaticOrManual OffsetMode { set;get; }

OffsetType
Gets or sets the OffsetType.

Declaration Syntax
public BeamOffsetType OffsetType { set;get; }

OffsetX
Gets or sets the OffsetX.

Declaration Syntax
public Quantity OffsetX { set;get; }

OffsetY
Gets or sets the OffsetY.

Declaration Syntax
public Quantity OffsetY { set;get; }

PipeExternalDiameter
Gets the PipeExternalDiameter.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 323
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity PipeExternalDiameter { get; }

PipeInternalDiameter
Gets the PipeInternalDiameter.

Declaration Syntax
public Quantity PipeInternalDiameter { get; }

PipeThickness
Gets the PipeThickness.

Declaration Syntax
public Quantity PipeThickness { get; }

ReferenceFrame
Gets or sets the ReferenceFrame.

Declaration Syntax
public ReferenceFrameType ReferenceFrame { set;get; }

ReferenceTemperature ***OBSOLETE*** Use 'UseReferenceTemperatureBy-


Body' property instead.
Gets or sets the ReferenceTemperature.

Declaration Syntax
public bool ReferenceTemperature { set;get; }

ReferenceTemperatureValue
Gets or sets the ReferenceTemperatureValue.

Declaration Syntax
public Quantity ReferenceTemperatureValue { set;get; }

ReinforcingStressState
Gets or sets the ReinforcingStressState.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public ReinforcingStressState ReinforcingStressState { set;get; }

ResultMeshId
Gets the related Result Mesh's ObjectId.

Declaration Syntax
public int ResultMeshId { get; }

ShellOffsetType
Gets or sets the ShellOffsetType.

Declaration Syntax
public ShellOffsetType ShellOffsetType { set;get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public Quantity StandardDeviation { get; }

StiffnessBehavior
Gets or sets the StiffnessBehavior.

Declaration Syntax
public StiffnessBehavior StiffnessBehavior { set;get; }

StiffnessOption
Gets or sets the StiffnessOption.

Declaration Syntax
public ShellElementStiffnessOption StiffnessOption { set;get; }

Suppressed
Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Suppressed { set;get; }

SuppressedParameterized
Gets if the part suppressed property is parameterized.

Declaration Syntax
public bool SuppressedParameterized { get; }

SurfaceArea
Gets the SurfaceArea.

Declaration Syntax
public Quantity SurfaceArea { get; }

ThermalStrainEffects
Gets or sets the ThermalStrainEffects.

Declaration Syntax
public bool ThermalStrainEffects { set;get; }

Thickness
Gets or sets the Thickness.

Declaration Syntax
public Quantity Thickness { set;get; }

ThicknessMode ***OBSOLETE*** Use 'ManualThicknessMode' property in-


stead.
Gets the ThicknessMode.

Declaration Syntax
public bool ThicknessMode { get; }

Transparency
Gets or sets the Transparency. Values range from 0.0 (fully invisible) to 1.0 (fully visible).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public double Transparency { set;get; }

Treatment
Gets or sets the Treatment.

Declaration Syntax
public BodyTreatment Treatment { set;get; }

UseReferenceTemperatureByBody
Gets or sets the UseReferenceTemperatureByBody.

Declaration Syntax
public bool UseReferenceTemperatureByBody { set;get; }

UserNameChange
Gets the UserNameChange.

Declaration Syntax
public bool UserNameChange { get; }

Visible
Gets or sets the Visible.

Declaration Syntax
public bool Visible { set;get; }

Volume
Gets the Volume.

Declaration Syntax
public Quantity Volume { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddPythonCodeEventBased()
Creates a new PythonCodeEventBased

Declaration Syntax
public virtual PythonCodeEventBased AddPythonCodeEventBased()

ClearGeneratedData()
Run the ClearGeneratedData action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
Body

Declaration Syntax
public virtual void ClearGeneratedData()

GenerateMesh()
Run the GenerateMesh action.

Declaration Syntax
public virtual void GenerateMesh()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
Ansys.ACT.Automation.Mechanical Namespace

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetGeoBody()
Gets the Geo Body

Declaration Syntax
public virtual IGeoBody GetGeoBody()

PreviewInflation()
Run the PreviewInflation action.

Declaration Syntax
public virtual void PreviewInflation()

PreviewSurfaceMesh()
Run the PreviewSurfaceMesh action.

Declaration Syntax
public virtual void PreviewSurfaceMesh()

ShowBody()
Run the ShowBody action.

Declaration Syntax
public virtual void ShowBody()

Update()
Run the Update action.

Declaration Syntax
public virtual void Update()

CenterOfGravityConstraint
Defines a CenterOfGravityConstraint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
CenterOfGravityConstraint

Declaration Syntax
public class CenterOfGravityConstraint : ResponseConstraint

Table 166: Members

Property Axis (p. 331) Gets or sets the Axis.


Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 331)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 331) Gets the internal object. For advanced usage only.
Property Location (p. 332) Gets or sets the Location.
Property MaximumPosition (p. 332) Gets or sets the MaximumPosition.
Property MinimumPosition (p. 332) Gets or sets the MinimumPosition.
Property ScopingMethod (p. 332) Gets or sets the ScopingMethod.
Property Selection (p. 332) Gets or sets the Selection.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MaximumPosition
Gets or sets the MaximumPosition.

Declaration Syntax
public Quantity MaximumPosition { set;get; }

MinimumPosition
Gets or sets the MinimumPosition.

Declaration Syntax
public Quantity MinimumPosition { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Selection
Gets or sets the Selection.

Declaration Syntax
public OptimizationRegion Selection { set;get; }

ChannelCrossSection
Defines a ChannelCrossSection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
ChannelCrossSection

Declaration Syntax
public class ChannelCrossSection : CrossSection

Table 167: Members

Property Area (p. 333) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 333)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 334) Gets the internal object. For advanced usage
only.
Property IYY (p. 334) Gets the IYY.
Property IZZ (p. 334) Gets the IZZ.
Property Thick1 (p. 334) Gets or sets the Thick1.
Property Thick2 (p. 334) Gets or sets the Thick2.
Property Thick3 (p. 334) Gets or sets the Thick3.
Property Width1 (p. 335) Gets or sets the Width1.
Property Width2 (p. 335) Gets or sets the Width2.
Property Width3 (p. 335) Gets or sets the Width3.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Declaration Syntax
public Quantity Thick2 { set;get; }

Thick3
Gets or sets the Thick3.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
Chart

Declaration Syntax
public Quantity Thick3 { set;get; }

Width1
Gets or sets the Width1.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

Width3
Gets or sets the Width3.

Declaration Syntax
public Quantity Width3 { set;get; }

Chart
Defines a Chart.

Declaration Syntax
public class Chart : DataModelObject, IFolderDataModelObject

Table 168: Members

Property Caption (p. 336) Gets or sets the Caption.


Property Children (p. 336) Gets the list of children.
Property Comments (p. 336) Gets the list of associated comments.
Property Content (p. 336) Gets or sets the Content.
Property DataModelObjectCategory (p. 337) Gets the current DataModelObject's category.
Property Gridlines (p. 337) Gets or sets the Gridlines.
Property Images (p. 337) Gets the list of associated images.
Property InternalObject (p. 337) Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
Ansys.ACT.Automation.Mechanical Namespace

Property ModalDisplayType (p. 337) Gets or sets the ModalDisplayType.


Property OutlineSelection (p. 337) Gets or sets the OutlineSelection.
Property PlotStyle (p. 338) Gets or sets the PlotStyle.
Property Scale (p. 338) Gets or sets the Scale.
Property XAxis (p. 338) Use to control the X Axis property of the chart.
Property XAxisLabel (p. 338) Gets or sets the XAxisLabel.
Property YAxisLabel (p. 338) Gets or sets the YAxisLabel.
Method AddComment() (p. 338) Creates a new child Comment.
Method AddImage(string) (p. 339) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 339) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 339)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 340)

Caption
Gets or sets the Caption.

Declaration Syntax
public string Caption { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Content
Gets or sets the Content.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
Chart

Declaration Syntax
public ChartReportType Content { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Gridlines
Gets or sets the Gridlines.

Declaration Syntax
public ChartGridlines Gridlines { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSChartAuto InternalObject { get; }

ModalDisplayType
Gets or sets the ModalDisplayType.

Declaration Syntax
public ChartModalType ModalDisplayType { set;get; }

OutlineSelection
Gets or sets the OutlineSelection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<IDataModelObject> OutlineSelection { set;get; }

PlotStyle
Gets or sets the PlotStyle.

Declaration Syntax
public ChartPlotStyle PlotStyle { set;get; }

Scale
Gets or sets the Scale.

Declaration Syntax
public ChartScale Scale { set;get; }

XAxis
Use to control the X Axis property of the chart.

Declaration Syntax
public ChartXAxis XAxis { get; }

XAxisLabel
Gets or sets the XAxisLabel.

Declaration Syntax
public string XAxisLabel { set;get; }

YAxisLabel
Gets or sets the YAxisLabel.

Declaration Syntax
public string YAxisLabel { set;get; }

AddComment()
Creates a new child Comment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
Chart

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
Ansys.ACT.Automation.Mechanical Namespace

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ChartXAxis
No details are provided for this entry.

Declaration Syntax
public class ChartXAxis

Table 169: Members

Property ComponentIndex (p. 340) Gets or sets the component index for the chart.
Property ObjectSelection (p. 341) Gets or sets the object being used to control the X Axis. Setting
to None returns to common independent variable.

ComponentIndex
Gets or sets the component index for the chart.

Declaration Syntax
public int ComponentIndex { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
340 of ANSYS, Inc. and its subsidiaries and affiliates.
CircularCrossSection

ObjectSelection
Gets or sets the object being used to control the X Axis. Setting to None returns to common inde-
pendent variable.

Declaration Syntax
public IDataModelObject ObjectSelection { set;get; }

CircularCrossSection
Defines a CircularCrossSection.

Declaration Syntax
public class CircularCrossSection : CrossSection

Table 170: Members

Property Area (p. 341) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 342)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 342) Gets the internal object. For advanced usage
only.
Property IYY (p. 342) Gets the IYY.
Property IZZ (p. 342) Gets the IZZ.
Property Radius (p. 342) Gets or sets the Radius.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Radius
Gets or sets the Radius.

Declaration Syntax
public Quantity Radius { set;get; }

CircularTubeCrossSection
Defines a CircularTubeCrossSection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
CircularTubeCrossSection

Declaration Syntax
public class CircularTubeCrossSection : CrossSection

Table 171: Members

Property Area (p. 343) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 343)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InnerRadius (p. 343) Gets or sets the InnerRadius.
Property InternalObject (p. 344) Gets the internal object. For advanced usage
only.
Property IYY (p. 344) Gets the IYY.
Property IZZ (p. 344) Gets the IZZ.
Property OuterRadius (p. 344) Gets or sets the OuterRadius.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InnerRadius
Gets or sets the InnerRadius.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity InnerRadius { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

OuterRadius
Gets or sets the OuterRadius.

Declaration Syntax
public Quantity OuterRadius { set;get; }

CommandSnippet
Defines a CommandSnippet.

Declaration Syntax
public class CommandSnippet : ImportedDataModelObject, IFolderDataModelObject

Table 172: Members

Property Children (p. 346) Gets the list of children.


Property Comments (p. 346) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

Property DataModelObjectCategory (p. 346) Gets the current DataModelObject's category.


Property Figures (p. 346) Gets the list of associated figures.
Property FileName (p. 346) Gets the FileName.
Property Images (p. 346) Gets the list of associated images.
Property Input (p. 347) Gets or sets the Text.
Property InputArgument1 (p. 347) Gets or sets the InputArgument1.
Property InputArgument2 (p. 347) Gets or sets the InputArgument2.
Property InputArgument3 (p. 347) Gets or sets the InputArgument3.
Property InputArgument4 (p. 347) Gets or sets the InputArgument4.
Property InputArgument5 (p. 347) Gets or sets the InputArgument5.
Property InputArgument6 (p. 348) Gets or sets the InputArgument6.
Property InputArgument7 (p. 348) Gets or sets the InputArgument7.
Property InputArgument8 (p. 348) Gets or sets the InputArgument8.
Property InputArgument9 (p. 348) Gets or sets the InputArgument9.
Property InternalObject (p. 348) Gets the internal object. For advanced usage only.
Property InvalidateSolution (p. 348) Gets or sets the InvalidateSolution.
Property IssueSolveCommand (p. 349) Gets or sets the IssueSolveCommand.
Property OutputParameters (p. 349) Gets a list of the command snippet's output
parameters.
Property OutputSearchPrefix (p. 349) Gets or sets the OutputSearchPrefix.
Property SnippetFileStatus (p. 349) Gets the SnippetFileStatus.
Property SolverTarget (p. 349) Gets the SolverTarget.
Property StepNumber (p. 349) Gets or sets the StepNumber.
Property StepSelectionMode (p. 350) Gets or sets the StepSelectionMode.
Property Suppressed (p. 350) Gets or sets the Suppressed.
Method AddComment() (p. 350) Creates a new child Comment.
Method AddFigure() (p. 350) Creates a new child Figure.
Method AddImage(string) (p. 350) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AppendText(string) (p. 351) Append Text.
Method Delete() (p. 351) Run the Delete action.
Method ExportTextFile(string) (p. 351) Export to Textfile.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 351)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 352)
Method ImportTextFile(string) (p. 352) Import from Textfile.
Method RenameBasedOnDefinition() (p. 353) Run the RenameBasedOnDefinition action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
Ansys.ACT.Automation.Mechanical Namespace

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FileName
Gets the FileName.

Declaration Syntax
public string FileName { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

Input
Gets or sets the Text.

Declaration Syntax
public string Input { set;get; }

InputArgument1
Gets or sets the InputArgument1.

Declaration Syntax
public string InputArgument1 { set;get; }

InputArgument2
Gets or sets the InputArgument2.

Declaration Syntax
public string InputArgument2 { set;get; }

InputArgument3
Gets or sets the InputArgument3.

Declaration Syntax
public string InputArgument3 { set;get; }

InputArgument4
Gets or sets the InputArgument4.

Declaration Syntax
public string InputArgument4 { set;get; }

InputArgument5
Gets or sets the InputArgument5.

Declaration Syntax
public string InputArgument5 { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
Ansys.ACT.Automation.Mechanical Namespace

InputArgument6
Gets or sets the InputArgument6.

Declaration Syntax
public string InputArgument6 { set;get; }

InputArgument7
Gets or sets the InputArgument7.

Declaration Syntax
public string InputArgument7 { set;get; }

InputArgument8
Gets or sets the InputArgument8.

Declaration Syntax
public string InputArgument8 { set;get; }

InputArgument9
Gets or sets the InputArgument9.

Declaration Syntax
public string InputArgument9 { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCommandEditorAuto InternalObject { get; }

InvalidateSolution
Gets or sets the InvalidateSolution.

Declaration Syntax
public bool InvalidateSolution { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
348 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

IssueSolveCommand
Gets or sets the IssueSolveCommand.

Declaration Syntax
public bool IssueSolveCommand { set;get; }

OutputParameters
Gets a list of the command snippet's output parameters.

Declaration Syntax
public IReadOnlyList<CommandOutputParameter> OutputParameters { get; }

OutputSearchPrefix
Gets or sets the OutputSearchPrefix.

Declaration Syntax
public string OutputSearchPrefix { set;get; }

SnippetFileStatus
Gets the SnippetFileStatus.

Declaration Syntax
public int SnippetFileStatus { get; }

SolverTarget
Gets the SolverTarget.

Declaration Syntax
public CommandEditorTarget SolverTarget { get; }

StepNumber
Gets or sets the StepNumber.

Declaration Syntax
public int StepNumber { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
Ansys.ACT.Automation.Mechanical Namespace

StepSelectionMode
Gets or sets the StepSelectionMode.

Declaration Syntax
public SequenceSelectionType StepSelectionMode { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandSnippet

AppendText(string)
Append Text.

Declaration Syntax
public virtual void AppendText(string NewText)

Parameters
NewText(string)

No details are provided for this entry.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ExportTextFile(string)
Export to Textfile.

Declaration Syntax
public virtual void ExportTextFile(string TextFile)

Parameters
TextFile(string)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 351
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ImportTextFile(string)
Import from Textfile.

Declaration Syntax
public virtual void ImportTextFile(string TextFile)

Parameters
TextFile(string)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
352 of ANSYS, Inc. and its subsidiaries and affiliates.
Comment

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Comment
Defines a Comment.

Declaration Syntax
public class Comment : DataModelObject, IFolderDataModelObject

Table 173: Members

Property Author (p. 353) Gets or sets the Author.


Property Children (p. 353) Gets the list of children.
Property DataModelObjectCategory (p. 354) Gets the current DataModelObject's
category.
Property InternalObject (p. 354) Gets the internal object. For advanced
usage only.
Property Text (p. 354) Gets the Text.
Method Delete() (p. 354) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 354)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 355)

Author
Gets or sets the Author.

Declaration Syntax
public string Author { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 353
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCommentAuto InternalObject { get; }

Text
Gets the Text.

Declaration Syntax
public string Text { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
354 of ANSYS, Inc. and its subsidiaries and affiliates.
ComplexityIndexConstraint

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ComplexityIndexConstraint
Defines a ComplexityIndexConstraint.

Defines a ComplexityIndexConstraint.

Declaration Syntax
public class ComplexityIndexConstraint : ManufacturingConstraint

Table 174: Members

Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property DataModelObjectCategory (p. 356)Gets the current DataModelObject's
category.
Property InternalObject (p. 356) Gets the internal object. For advanced usage
only.
Property Selection (p. 703) Gets or sets the Selection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 355
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

ComplianceConstraint
Defines a ComplianceConstraint.

Declaration Syntax
public class ComplianceConstraint : ResponseConstraint

Table 175: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property ComplianceLimit (p. 357) Gets or sets the ComplianceLimit.
Property DataModelObjectCategory (p. 357)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 357) Gets the internal object. For advanced usage only.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
CompositeCriterion

ComplianceLimit
Gets or sets the ComplianceLimit.

Declaration Syntax
public Field ComplianceLimit { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

CompositeCriterion
Defines a CompositeCriterion.

Declaration Syntax
public class CompositeCriterion : Criterion

Table 176: Members

Property Children (p. 447) Gets the list of children.

(Inherited from Criterion (p. 446).)


Property Comments (p. 447) Gets the list of associated comments.

(Inherited from Criterion (p. 446).)


Property DataModelObjectCategory (p. 358)Gets the current DataModelObject's category.
Property Figures (p. 447) Gets the list of associated figures.

(Inherited from Criterion (p. 446).)


Property Images (p. 448) Gets the list of associated images.

(Inherited from Criterion (p. 446).)


Property InternalObject (p. 358) Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 357
Ansys.ACT.Automation.Mechanical Namespace

Property Suppressed (p. 448) Gets or sets the Suppressed.

(Inherited from Criterion (p. 446).)


Property Value (p. 358) Gets the Value.
Method ClearGeneratedData() (p. 358) Run the ClearGeneratedData action.
Method EvaluateAllResults() (p. 358) Run the EvaluateAllResults action.
Method GetDefinition() (p. 359) Gets the Worksheet Definition. This Definition is a list of
CompositeCriterionTerms.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoCriterionAuto InternalObject { get; }

Value
Gets the Value.

Declaration Syntax
public Quantity Value { get; }

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

EvaluateAllResults()
Run the EvaluateAllResults action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
CompositeCriterionDefinition

Declaration Syntax
public virtual void EvaluateAllResults()

GetDefinition()
Gets the Worksheet Definition. This Definition is a list of CompositeCriterionTerms.

Declaration Syntax
public virtual CompositeCriterionDefinition GetDefinition()

CompositeCriterionDefinition
No details are provided for this entry.

Declaration Syntax
public class CompositeCriterionDefinition : IList<CompositeCriterionTerm>, ICollection<CompositeCri-
terionTerm>, IEnumerable<CompositeCriterionTerm>, IEnumerable

Table 177: Members

Property Count (p. 359) Gives the number of CompositeCriterionTerms in the definition.
Property Item (p. 360) No details are provided for this entry.
Method Add(CompositeCriterionTerm) (p. 360) Adds a CompositeCriterionTerm at the end in the definition. Usage:
CriterionDefinition.Add(Ansys.ACT.Automation.Mechanical.Composit
1.3))
Method Clear() (p. 360) Clears all the CompositeCriterionTerms in the definition.
Method IndexOf(CompositeCriterionTerm) (p. 360) Gives the index where the specified CompositeCriterionTerm exists
Returns -1 if the term is not found in the definition.
Method Insert(int, Inserts a CompositeCriterionTerm at a specified index in the definiti
CompositeCriterionTerm) (p. 361) IndexOutOfRangeException for invalid index. Usage: CriterionDefinit
Ansys.ACT.Automation.Mechanical.CompositeCriterionTerm(primCrit
Method RemoveAt(int) (p. 361) Removes the CompositeCriterionTerm at a specified index in the de
IndexOutOfRangeException for invalid index.

Count
Gives the number of CompositeCriterionTerms in the definition.

Declaration Syntax
public int Count { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 359
Ansys.ACT.Automation.Mechanical Namespace

Item(int)
No details are provided for this entry.

Declaration Syntax
public CompositeCriterionTerm Item { set;get; }

Add(CompositeCriterionTerm)
Adds a CompositeCriterionTerm at the end in the definition. Usage: CriterionDefinition.Add(An-
sys.ACT.Automation.Mechanical.CompositeCriterionTerm(primCritObj, 1.3))

Declaration Syntax
public virtual void Add(CompositeCriterionTerm item)

Parameters
item(CompositeCriterionTerm)

No details are provided for this entry.

Clear()
Clears all the CompositeCriterionTerms in the definition.

Declaration Syntax
public virtual void Clear()

IndexOf(CompositeCriterionTerm)
Gives the index where the specified CompositeCriterionTerm exists in the definition. Returns -1 if the
term is not found in the definition.

Declaration Syntax
public virtual int IndexOf(CompositeCriterionTerm item)

Parameters
item(CompositeCriterionTerm)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
CompositeCriterionTerm

Insert(int, CompositeCriterionTerm)
Inserts a CompositeCriterionTerm at a specified index in the definition. Returns IndexOutOfRangeEx-
ception for invalid index. Usage: CriterionDefinition.Insert(1, Ansys.ACT.Automation.Mechanical.Com-
positeCriterionTerm(primCritObj, 1.3))

Declaration Syntax
public virtual void Insert(int index, CompositeCriterionTerm item)

Parameters
index(int)

No details are provided for this entry.

item(CompositeCriterionTerm)

No details are provided for this entry.

RemoveAt(int)
Removes the CompositeCriterionTerm at a specified index in the definition. Returns IndexOutOfRan-
geException for invalid index.

Declaration Syntax
public virtual void RemoveAt(int index)

Parameters
index(int)

No details are provided for this entry.

CompositeCriterionTerm
No details are provided for this entry.

Declaration Syntax
public class CompositeCriterionTerm

Table 178: Members

Constructor CompositeCriterionTerm() (p. 362) Creates and returns a new


CompositeCriterionTerm.
Constructor CompositeCriterionTerm(PrimaryCriterion, Returns a new CompositeCriterionTerm with
double) (p. 362) given inputs

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 361
Ansys.ACT.Automation.Mechanical Namespace

Property Coefficient (p. 362) Returns coefficient of PrimaryCriterion in the


CompositeCriterionTerm.
Property PrimaryCriterion (p. 362) Returns PrimaryCriterion Object associated
with the CompositeCriterionTerm. Returns
None if no PrimaryCriterion Object is assigned
to CompositeCriterionTerm.

CompositeCriterionTerm()
Creates and returns a new CompositeCriterionTerm.

Declaration Syntax
public CompositeCriterionTerm()

CompositeCriterionTerm(PrimaryCriterion, double)
Returns a new CompositeCriterionTerm with given inputs

Declaration Syntax
public CompositeCriterionTerm(PrimaryCriterion primCritObj, double coeffiecient)

Parameters
primCritObj(PrimaryCriterion)

No details are provided for this entry.

coeffiecient(double)

No details are provided for this entry.

Coefficient
Returns coefficient of PrimaryCriterion in the CompositeCriterionTerm.

Declaration Syntax
public double Coefficient { set;get; }

PrimaryCriterion
Returns PrimaryCriterion Object associated with the CompositeCriterionTerm. Returns None if no
PrimaryCriterion Object is assigned to CompositeCriterionTerm.

Declaration Syntax
public PrimaryCriterion PrimaryCriterion { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedGeometry

CondensedGeometry
Defines a CondensedGeometry.

Declaration Syntax
public class CondensedGeometry : DataModelObject, IFolderDataModelObject

Table 179: Members

Property Children (p. 363) Gets the list of children.


Property Comments (p. 364) Gets the list of associated comments.
Property DataModelObjectCategory (p. 364) Gets the current DataModelObject's category.
Property Figures (p. 364) Gets the list of associated figures.
Property Images (p. 364) Gets the list of associated images.
Property InternalObject (p. 364) Gets the internal object. For advanced usage
only.
Property SolverFilesDirectory (p. 364) Gets the SolverFilesDirectory.
Property TransparencyEnabled (p. 365) Gets or sets the TransparencyEnabled.
Method AddComment() (p. 365) Creates a new child Comment.
Method AddCondensedPart() (p. 365) Creates a new CondensedPart
Method AddCondensedPartInfoTool() (p. 365) Creates a new CondensedPartInfoTool
Method AddFigure() (p. 365) Creates a new child Figure.
Method AddImage(string) (p. 365) Creates a new child Image. If a filePath is
provided, the image will be loaded from that file,
if not, the image will be a screen capture of the
Geometry window.
Method AddImportedCondensedPart() (p. 366) Creates a new ImportedCondensedPart
Method ClearGeneratedData() (p. 366) Run the ClearGeneratedData action.
Method CreateAutomaticCondensedParts() (p. 366) Run the CreateAutomaticCondensedParts action.
Method Delete() (p. 366) Run the Delete action.
Method GenerateCondensedParts() (p. 366) Run the GenerateCondensedParts action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 367)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 367)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 363
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCondensedGeometryAuto InternalObject { get; }

SolverFilesDirectory
Gets the SolverFilesDirectory.

Declaration Syntax
public string SolverFilesDirectory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedGeometry

TransparencyEnabled
Gets or sets the TransparencyEnabled.

Declaration Syntax
public bool TransparencyEnabled { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCondensedPart()
Creates a new CondensedPart

Declaration Syntax
public virtual CondensedPart AddCondensedPart()

AddCondensedPartInfoTool()
Creates a new CondensedPartInfoTool

Declaration Syntax
public virtual CondensedPartInfoTool AddCondensedPartInfoTool()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 365
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImportedCondensedPart()
Creates a new ImportedCondensedPart

Declaration Syntax
public virtual ImportedCondensedPart AddImportedCondensedPart()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateAutomaticCondensedParts()
Run the CreateAutomaticCondensedParts action.

Declaration Syntax
public virtual void CreateAutomaticCondensedParts()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GenerateCondensedParts()
Run the GenerateCondensedParts action.

Declaration Syntax
public virtual void GenerateCondensedParts()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

CondensedPart
Defines a CondensedPart.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 367
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CondensedPart : CondensedPartBase

Table 180: Members

Property AttachmentMethod (p. 369) Gets or sets the AttachmentMethod.


Property Children (p. 374) Gets the list of children.

(Inherited from CondensedPartBase (p. 373).)


Property Comments (p. 374) Gets the list of associated comments.

(Inherited from CondensedPartBase (p. 373).)


Property DataModelObjectCategory (p. 369) Gets the current DataModelObject's category.
Property Figures (p. 375) Gets the list of associated figures.

(Inherited from CondensedPartBase (p. 373).)


Property FutureExpansion (p. 370) Gets or sets the FutureExpansion.
Property FutureIntent (p. 370) "FutureIntent" property defines the type of solver
supported to perform a use pass with the
condensed part.
Property GenerateDampingMatrix (p. 370) Gets or sets the GenerateDampingMatrix.
Property GeometrySelection (p. 375) Gets or sets the GeometrySelection.

(Inherited from CondensedPartBase (p. 373).)


Property Images (p. 375) Gets the list of associated images.

(Inherited from CondensedPartBase (p. 373).)


Property InterfaceMethod (p. 370) Gets or sets the InterfaceMethod.
Property Interfaces (p. 370) Returns the Interfaces of the condensed part
Property InternalObject (p. 370) Gets the internal object. For advanced usage only.
Property KeepFilesFor (p. 371) Gets or sets the KeepFilesFor.
Property LumpedMassFormulation (p. 371) Gets or sets the LumpedMassFormulation.
Property MaximumFrequency (p. 371) Gets or sets the MaximumFrequency.
Property MinimumFrequency (p. 371) Gets or sets the MinimumFrequency.
Property NumberInterfaceEntries (p. 375) Gets the NumberInterfaceEntries.

(Inherited from CondensedPartBase (p. 373).)


Property NumberMasterNodes (p. 375) Gets the NumberMasterNodes.

(Inherited from CondensedPartBase (p. 373).)


Property NumberOfModes (p. 371) Gets or sets the NumberOfModes.
Property Physics (p. 376) Gets the Physics.

(Inherited from CondensedPartBase (p. 373).)


Property PointMassTreatment (p. 371) Gets or sets the PointMassTreatment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

Property RangeSearch (p. 372) Gets or sets the RangeSearch.


Property ReductionMethod (p. 372) Gets or sets the ReductionMethod.
Property ReferenceTemperature (p. 376) Gets or sets the ReferenceTemperature.

(Inherited from CondensedPartBase (p. 373).)


Property SolutionName (p. 376) Gets or sets the SolutionName.

(Inherited from CondensedPartBase (p. 373).)


Property SolutionNameMode (p. 376) Gets or sets the SolutionNameMode.

(Inherited from CondensedPartBase (p. 373).)


Property SolverFilesDirectory (p. 376) Gets the SolverFilesDirectory.

(Inherited from CondensedPartBase (p. 373).)


Property SolverType (p. 372) Gets or sets the SolverType.
Property SolverUnits (p. 376) Gets or sets the SolverUnits.

(Inherited from CondensedPartBase (p. 373).)


Property SolverUnitSystem (p. 377) Gets or sets the SolverUnitSystem.

(Inherited from CondensedPartBase (p. 373).)


Property StoreBasisResults (p. 372) Gets or sets the StoreBasisResults.
Property Suppressed (p. 377) Gets or sets the Suppressed.

(Inherited from CondensedPartBase (p. 373).)


Property TemperatureUnits (p. 377) Gets the TemperatureUnits.

(Inherited from CondensedPartBase (p. 373).)


Method DetectCondensedPartInterface() (p. 372) Run the DetectCondensedPartInterface action.
Method Export(string, ExportFormat, Run the Export Condensed Part action.
ExportSettings) (p. 372)
Method GenerateCondensedParts() (p. 373) Run the GenerateCondensedParts action.

AttachmentMethod
Gets or sets the AttachmentMethod.

Declaration Syntax
public CondensedPartCMSAttachmentMethod AttachmentMethod { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 369
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FutureExpansion
Gets or sets the FutureExpansion.

Declaration Syntax
public YesNoProgrammedControlled FutureExpansion { set;get; }

FutureIntent
"FutureIntent" property defines the type of solver supported to perform a use pass with the condensed
part.

Declaration Syntax
public FutureIntentType FutureIntent { set;get; }

GenerateDampingMatrix
Gets or sets the GenerateDampingMatrix.

Declaration Syntax
public YesNoProgrammedControlled GenerateDampingMatrix { set;get; }

InterfaceMethod
Gets or sets the InterfaceMethod.

Declaration Syntax
public CondensedPartInterfaceMethod InterfaceMethod { set;get; }

Interfaces
Returns the Interfaces of the condensed part

Declaration Syntax
public CondensedPartInterfaces Interfaces { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPart

Declaration Syntax
public IDSCondensedPartAuto InternalObject { get; }

KeepFilesFor
Gets or sets the KeepFilesFor.

Declaration Syntax
public CondensedPartKeepFilesFor KeepFilesFor { set;get; }

LumpedMassFormulation
Gets or sets the LumpedMassFormulation.

Declaration Syntax
public CondensedPartLumpedMassFormulation LumpedMassFormulation { set;get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

NumberOfModes
Gets or sets the NumberOfModes.

Declaration Syntax
public int NumberOfModes { set;get; }

PointMassTreatment
Gets or sets the PointMassTreatment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 371
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CondensedPartPointMassTreatment PointMassTreatment { set;get; }

RangeSearch
Gets or sets the RangeSearch.

Declaration Syntax
public bool RangeSearch { set;get; }

ReductionMethod
Gets or sets the ReductionMethod.

Declaration Syntax
public CondensedPartReductionMethod ReductionMethod { set;get; }

SolverType
Gets or sets the SolverType.

Declaration Syntax
public SolverType SolverType { set;get; }

StoreBasisResults
Gets or sets the StoreBasisResults.

Declaration Syntax
public YesNoProgrammedControlled StoreBasisResults { set;get; }

DetectCondensedPartInterface()
Run the DetectCondensedPartInterface action.

Declaration Syntax
public virtual void DetectCondensedPartInterface()

Export(string, ExportFormat, ExportSettings)


Run the Export Condensed Part action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartBase

Declaration Syntax
public virtual void Export(string exportFileName, ExportFormat exportFormat, ExportSettings exportSet-
tings)

Parameters
exportFileName(string)

File path for the cpa file to be exported

exportFormat(ExportFormat)

The format to use when exporting.

exportSettings(ExportSettings)

The settings to use when exporting.

GenerateCondensedParts()
Run the GenerateCondensedParts action.

Declaration Syntax
public virtual void GenerateCondensedParts()

CondensedPartBase
Defines a CondensedPartBase.

Declaration Syntax
public class CondensedPartBase : DataModelObject, IFolderDataModelObject

Table 181: Members

Property Children (p. 374) Gets the list of children.


Property Comments (p. 374) Gets the list of associated comments.
Property DataModelObjectCategory (p. 374) Gets the current DataModelObject's category.
Property Figures (p. 375) Gets the list of associated figures.
Property GeometrySelection (p. 375) Gets or sets the GeometrySelection.
Property Images (p. 375) Gets the list of associated images.
Property InternalObject (p. 375) Gets the internal object. For advanced usage only.
Property NumberInterfaceEntries (p. 375) Gets the NumberInterfaceEntries.
Property NumberMasterNodes (p. 375) Gets the NumberMasterNodes.
Property Physics (p. 376) Gets the Physics.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 373
Ansys.ACT.Automation.Mechanical Namespace

Property ReferenceTemperature (p. 376) Gets or sets the ReferenceTemperature.


Property SolutionName (p. 376) Gets or sets the SolutionName.
Property SolutionNameMode (p. 376) Gets or sets the SolutionNameMode.
Property SolverFilesDirectory (p. 376) Gets the SolverFilesDirectory.
Property SolverUnits (p. 376) Gets or sets the SolverUnits.
Property SolverUnitSystem (p. 377) Gets or sets the SolverUnitSystem.
Property Suppressed (p. 377) Gets or sets the Suppressed.
Property TemperatureUnits (p. 377) Gets the TemperatureUnits.
Method AddCommandSnippet() (p. 377) Creates a new CommandSnippet
Method AddComment() (p. 377) Creates a new child Comment.
Method AddFigure() (p. 377) Creates a new child Figure.
Method AddImage(string) (p. 378) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 378) Run the ClearGeneratedData action.
Method Delete() (p. 378) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 378)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 379)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartBase

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCondensedPartAuto InternalObject { get; }

NumberInterfaceEntries
Gets the NumberInterfaceEntries.

Declaration Syntax
public int NumberInterfaceEntries { get; }

NumberMasterNodes
Gets the NumberMasterNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 375
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int NumberMasterNodes { get; }

Physics
Gets the Physics.

Declaration Syntax
public CondensedPartPhysics Physics { get; }

ReferenceTemperature
Gets or sets the ReferenceTemperature.

Declaration Syntax
public Quantity ReferenceTemperature { set;get; }

SolutionName
Gets or sets the SolutionName.

Declaration Syntax
public string SolutionName { set;get; }

SolutionNameMode
Gets or sets the SolutionNameMode.

Declaration Syntax
public AutomaticOrManual SolutionNameMode { set;get; }

SolverFilesDirectory
Gets the SolverFilesDirectory.

Declaration Syntax
public string SolverFilesDirectory { get; }

SolverUnits
Gets or sets the SolverUnits.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartBase

Declaration Syntax
public SolverUnitsControlType SolverUnits { set;get; }

SolverUnitSystem
Gets or sets the SolverUnitSystem.

Declaration Syntax
public WBUnitSystemType SolverUnitSystem { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TemperatureUnits
Gets the TemperatureUnits.

Declaration Syntax
public string TemperatureUnits { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 377
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartExpansionState

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

CondensedPartExpansionState
No details are provided for this entry.

Declaration Syntax
public class CondensedPartExpansionState

Table 182: Members

Constructor CondensedPartExpansionState() (p. 379) Expansion State object.


Property Displacement (p. 380) Gets or sets the Displacement
Property
Property Stress (p. 380) Gets or sets the Stress Property

CondensedPartExpansionState()
Expansion State object.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CondensedPartExpansionState()

Displacement
Gets or sets the Displacement Property

Declaration Syntax
public bool Displacement { set;get; }

Stress
Gets or sets the Stress Property

Declaration Syntax
public bool Stress { set;get; }

CondensedPartInfoTool
Defines a CondensedPartInfoTool.

Declaration Syntax
public class CondensedPartInfoTool : DataModelObject, IFolderDataModelObject

Table 183: Members

Property Children (p. 381) Gets the list of children.


Property Comments (p. 381) Gets the list of associated comments.
Property DataModelObjectCategory (p. 381) Gets the current DataModelObject's category.
Property Images (p. 381) Gets the list of associated images.
Property InternalObject (p. 381) Gets the internal object. For advanced usage only.
Property Text (p. 381) Gets the Text.
Property UpdateInterval (p. 382) Gets or sets the UpdateInterval.
Method AddComment() (p. 382) Creates a new child Comment.
Method AddImage(string) (p. 382) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 382) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 382)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartInfoTool

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 383)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCondensedPartInfoToolAuto InternalObject { get; }

Text
Gets the Text.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public string Text { get; }

UpdateInterval
Gets or sets the UpdateInterval.

Declaration Syntax
public double UpdateInterval { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartInterface

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

CondensedPartInterface
No details are provided for this entry.

Declaration Syntax
public class CondensedPartInterface

Table 184: Members

Property AllSelection (p. 384) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
Ansys.ACT.Automation.Mechanical Namespace

Property NamedSelection (p. 384) Gets or Sets NamedSelection


Property RemotePointSelection (p. 384) Gets or Sets RemotePointSelection
Property Type (p. 384) Gets or Sets Condensed part interface
type

AllSelection
No details are provided for this entry.

Declaration Syntax
public ImportedDataModelObject AllSelection { set;get; }

NamedSelection
Gets or Sets NamedSelection

Declaration Syntax
public NamedSelection NamedSelection { set;get; }

RemotePointSelection
Gets or Sets RemotePointSelection

Declaration Syntax
public RemotePoint RemotePointSelection { set;get; }

Type
Gets or Sets Condensed part interface type

Declaration Syntax
public CondensedPartInterfaceType Type { set;get; }

CondensedPartInterfaces
A collection of condensed part interface.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
CondensedPartInterfaces

Declaration Syntax
public class CondensedPartInterfaces : IReadOnlyList<CondensedPartInterface>, IReadOnlyCollection<Con-
densedPartInterface>, IEnumerable<CondensedPartInterface>, IEnumerable

Table 185: Members

Property Item (p. 385) Condensed part interface at the given index.
Method Add() (p. 385) Add new condensed part interface
Method Clear() (p. 385) Clears all the condensed part interfaces
Method RemoveAt(int) (p. 385) Remove condensed part interface at the given
index

Item(int)
Condensed part interface at the given index.

Declaration Syntax
public CondensedPartInterface Item { get; }

Add()
Add new condensed part interface

Declaration Syntax
public void Add()

Clear()
Clears all the condensed part interfaces

Declaration Syntax
public void Clear()

RemoveAt(int)
Remove condensed part interface at the given index

Declaration Syntax
public void RemoveAt(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

No details are provided for this entry.

ConstructionGeometry
Defines a ConstructionGeometry.

Declaration Syntax
public class ConstructionGeometry : DataModelObject, IFolderDataModelObject

Table 186: Members

Property Children (p. 387) Gets the list of children.


Property Comments (p. 387) Gets the list of associated comments.
Property DataModelObjectCategory (p. 387) Gets the current DataModelObject's category.
Property Figures (p. 387) Gets the list of associated figures.
Property Images (p. 387) Gets the list of associated images.
Property InternalObject (p. 387) Gets the internal object. For advanced usage only.
Property ShowMesh (p. 388) Gets or sets the ShowMesh.
Method AddComment() (p. 388) Creates a new child Comment.
Method AddConstructionLine() (p. 388) Creates a new ConstructionLine
Method AddConstructionPoint() (p. 388) Creates a new ConstructionPoint
Method AddFigure() (p. 388) Creates a new child Figure.
Method AddImage(string) (p. 388) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddPath() (p. 389) Creates a new Path
Method AddSolid() (p. 389) Creates a new Solid
Method AddSTL() (p. 389) Creates a new STL
Method AddSurface() (p. 389) Creates a new Surface
Method Delete() (p. 389) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 390)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 390)
Method UpdateAllSolids() (p. 390) Update all solid parts under the Construction
Geometry folder.
Method UpdateSolids() (p. 391) Update only the solids that are activated

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionGeometry

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSConstructionGeometryGroupAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
Ansys.ACT.Automation.Mechanical Namespace

ShowMesh
Gets or sets the ShowMesh.

Declaration Syntax
public bool ShowMesh { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddConstructionLine()
Creates a new ConstructionLine

Declaration Syntax
public virtual ConstructionLine AddConstructionLine()

AddConstructionPoint()
Creates a new ConstructionPoint

Declaration Syntax
public virtual ConstructionPoint AddConstructionPoint()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionGeometry

Parameters
filePath(string)

Full path of file. Defaults to None.

AddPath()
Creates a new Path

Declaration Syntax
public virtual Path AddPath()

AddSolid()
Creates a new Solid

Declaration Syntax
public virtual Solid AddSolid()

AddSTL()
Creates a new STL

Declaration Syntax
public virtual STL AddSTL()

AddSurface()
Creates a new Surface

Declaration Syntax
public virtual Surface AddSurface()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 389
Ansys.ACT.Automation.Mechanical Namespace

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

UpdateAllSolids()
Update all solid parts under the Construction Geometry folder.

Declaration Syntax
public virtual void UpdateAllSolids()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionPoint

UpdateSolids()
Update only the solids that are activated

Declaration Syntax
public virtual void UpdateSolids()

ConstructionPoint
Defines a ConstructionPoint.

Declaration Syntax
public class ConstructionPoint : DataModelObject, IFolderDataModelObject

Table 187: Members

Property Children (p. 391) Gets the list of children.


Property Comments (p. 392) Gets the list of associated comments.
Property DataModelObjectCategory (p. 392) Gets the current DataModelObject's category.
Property Figures (p. 392) Gets the list of associated figures.
Property Images (p. 392) Gets the list of associated images.
Property InternalObject (p. 392) Gets the internal object. For advanced usage only.
Property LocationX (p. 392) Gets or sets the LocationX.
Property LocationY (p. 393) Gets or sets the LocationY.
Property LocationZ (p. 393) Gets or sets the LocationZ.
Property SetLocation (p. 393) Sets the point location.
Method AddComment() (p. 393) Creates a new child Comment.
Method AddFigure() (p. 393) Creates a new child Figure.
Method AddImage(string) (p. 393) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 394) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 394)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 394)

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 391
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSConstructionPointAuto InternalObject { get; }

LocationX
Gets or sets the LocationX.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
ConstructionPoint

Declaration Syntax
public Quantity LocationX { set;get; }

LocationY
Gets or sets the LocationY.

Declaration Syntax
public Quantity LocationY { set;get; }

LocationZ
Gets or sets the LocationZ.

Declaration Syntax
public Quantity LocationZ { set;get; }

SetLocation
Sets the point location.

Declaration Syntax
public ISelectionInfo SetLocation { set; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 393
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDebonding

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ContactDebonding
Defines a ContactDebonding.

Declaration Syntax
public class ContactDebonding : DataModelObject

Table 188: Members

Property ContactRegion (p. 395) Gets or sets the ContactRegion.


Property CriticalRate (p. 396) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 396) Gets the current DataModelObject's
category.
Property GenerationMethod (p. 396) Gets or sets the GenerationMethod.
Property InitialCrack (p. 396) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 396) Gets or sets the InitialTimeStep.
Property InternalObject (p. 396) Gets the internal object. For advanced usage
only.
Property Material (p. 397) Gets or sets the Material.
Property MaximumTimeStep (p. 397) Gets or sets the MaximumTimeStep.
Property Method (p. 397) Gets or sets the Method.
Property MinimumTimeStep (p. 397) Gets or sets the MinimumTimeStep.
Property Suppressed (p. 397) Gets or sets the Suppressed.
Property Type (p. 397) Gets the Type.
Method AddCommandSnippet() (p. 398) Creates a new CommandSnippet
Method Delete() (p. 398) Run the Delete action.

ContactRegion
Gets or sets the ContactRegion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 395
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

CriticalRate
Gets or sets the CriticalRate.

Declaration Syntax
public Quantity CriticalRate { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

GenerationMethod
Gets or sets the GenerationMethod.

Declaration Syntax
public DelaminationGenerationMethod GenerationMethod { set;get; }

InitialCrack
Gets or sets the InitialCrack.

Declaration Syntax
public GenericCrack InitialCrack { set;get; }

InitialTimeStep
Gets or sets the InitialTimeStep.

Declaration Syntax
public Quantity InitialTimeStep { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDebonding

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaximumTimeStep
Gets or sets the MaximumTimeStep.

Declaration Syntax
public Quantity MaximumTimeStep { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public DelaminationMethod Method { set;get; }

MinimumTimeStep
Gets or sets the MinimumTimeStep.

Declaration Syntax
public Quantity MinimumTimeStep { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Type
Gets the Type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 397
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DelaminationType Type { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ContactMatch
Defines a ContactMatch.

Declaration Syntax
public class ContactMatch : MeshConnectionBase

Table 189: Members

Property Children (p. 743) Gets the list of children.

(Inherited from
MeshConnectionBase (p. 742).)
Property Comments (p. 743) Gets the list of associated comments.

(Inherited from
MeshConnectionBase (p. 742).)
Property DataModelObjectCategory (p. 400)Gets the current DataModelObject's
category.
Property Figures (p. 743) Gets the list of associated figures.

(Inherited from
MeshConnectionBase (p. 742).)
Property Images (p. 743) Gets the list of associated images.

(Inherited from
MeshConnectionBase (p. 742).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
398 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactMatch

Property InternalObject (p. 400) Gets the internal object. For advanced usage
only.
Property MasterBodies (p. 744) Gets the MasterBodies.

(Inherited from
MeshConnectionBase (p. 742).)
Property MasterLocation (p. 744) Gets or sets the MasterLocation.

(Inherited from
MeshConnectionBase (p. 742).)
Property ScopeMode (p. 744) Gets the ScopeMode.

(Inherited from
MeshConnectionBase (p. 742).)
Property ScopingMethod (p. 744) No details are provided for this entry.

(Inherited from
MeshConnectionBase (p. 742).)
Property SlaveBodies (p. 744) Gets the SlaveBodies.

(Inherited from
MeshConnectionBase (p. 742).)
Property SlaveLocation (p. 744) Gets or sets the SlaveLocation.

(Inherited from
MeshConnectionBase (p. 742).)
Property SnapToBoundary (p. 745) Gets or sets the SnapToBoundary.

(Inherited from
MeshConnectionBase (p. 742).)
Property SnapTolerance (p. 745) Gets or sets the SnapTolerance.

(Inherited from
MeshConnectionBase (p. 742).)
Property SnapType (p. 745) Gets or sets the SnapType.

(Inherited from
MeshConnectionBase (p. 742).)
Property Suppressed (p. 745) Gets or sets the Suppressed.

(Inherited from
MeshConnectionBase (p. 742).)
Property ToleranceSlider (p. 745) Gets or sets the ToleranceSlider.

(Inherited from
MeshConnectionBase (p. 742).)
Property ToleranceType (p. 745) Gets or sets the ToleranceType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 399
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
MeshConnectionBase (p. 742).)
Property ToleranceValue (p. 400) Gets or sets the ToleranceValue.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshConnectionAuto InternalObject { get; }

ToleranceValue
Gets or sets the ToleranceValue.

Declaration Syntax
public Quantity ToleranceValue { set;get; }

ContactMatchGroup
Defines a ContactMatchGroup.

Defines a ContactMatchGroup.

Declaration Syntax
public class ContactMatchGroup : ConnectionGroup

Table 190: Members

Property ActiveConnections (p. 3562) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 3560).)


Property AutomaticFixedJoints (p. 3562) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 3560).)


Property Children (p. 3562) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
400 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactMatchGroup

(Inherited from ConnectionGroup (p. 3560).)


Property Comments (p. 3562) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 3560).)


Property Connections (p. 3563) Gets the Connections.

(Inherited from ConnectionGroup (p. 3560).)


Property ConnectionType (p. 3563) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 3560).)


Property CylindricalFaces (p. 3563) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 3560).)


Property DataModelObjectCategory (p. 402) Gets the current DataModelObject's category.
Property EdgeEdge (p. 3563) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 3560).)


Property EdgeOverlapTolerance (p. 3563) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceAngleTolerance (p. 3564) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceEdge (p. 3564) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceFace (p. 3564) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceFaceDetectionAngleTolerence (p. 3564)Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceOverlapTolerance (p. 3564) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property Figures (p. 3564) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 3560).)


Property GroupBy (p. 3565) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 3560).)


Property Images (p. 3565) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 3560).)


Property InternalObject (p. 402) Gets the internal object. For advanced usage
only.
Property Location (p. 3565) Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 401
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 3560).)


Property MinimumDistancePercentage (p. 3565) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 3560).)


Property MinimumDistanceValue (p. 3565) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 3560).)


Property Priority (p. 3566) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 3560).)


Property RevoluteJoints (p. 3566) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 3560).)


Property SearchAcross (p. 3566) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 3560).)


Property Suppressed (p. 3566) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 3560).)


Property ThicknessScaleFactor (p. 3566) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceSlider (p. 3566) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceType (p. 3567) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceValue (p. 3567) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 3560).)


Property UseRange (p. 3567) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 3560).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactSolutionInformation

Declaration Syntax
public IDSConnectionGroupAuto InternalObject { get; }

ContactSolutionInformation
Defines a ContactSolutionInformation.

Declaration Syntax
public class ContactSolutionInformation : DataModelObject, IFolderDataModelObject

Table 191: Members

Property Children (p. 403) Gets the list of children.


Property Comments (p. 403) Gets the list of associated comments.
Property DataModelObjectCategory (p. 404) Gets the current DataModelObject's category.
Property Images (p. 404) Gets the list of associated images.
Property InternalObject (p. 404) Gets the internal object. For advanced usage only.
Property UpdateInterval (p. 404) Gets or sets the UpdateInterval.
Method AddComment() (p. 404) Creates a new child Comment.
Method AddImage(string) (p. 404) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 405) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 405)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 405)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 403
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSContactInfoToolAuto InternalObject { get; }

UpdateInterval
Gets or sets the UpdateInterval.

Declaration Syntax
public double UpdateInterval { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
404 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactSolutionInformation

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 405
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

CoordinateSystem
Defines a CoordinateSystem.

Declaration Syntax
public class CoordinateSystem : ImportedDataModelObject, ICoordinateSystem, ICoordinateSystemSe-
lection, IFolderDataModelObject

Table 192: Members

Property APDLName (p. 409) Gets or sets the


APDLName.
Property Children (p. 409) Gets the list of children.
Property Comments (p. 410) Gets the list of associated
comments.
Property CoordinateSystemID (p. 410) Gets or sets the
CoordinateSystemID.
Property CoordinateSystemIDGeneration (p. 410) Gets or sets the
CoordinateSystemIDGeneration.
Property CoordinateSystemType (p. 410) Gets or sets the
CoordinateSystemType.
Property DataModelObjectCategory (p. 410) Gets the current
DataModelObject's
category.
Property Figures (p. 410) Gets the list of associated
figures.
Property GloballyAvailable (p. 411) Gets or sets the
GloballyAvailable.
Property Images (p. 411) Gets the list of associated
images.
Property InternalObject (p. 411) Gets the internal object.
For advanced usage only.
Property IsGlobal (p. 411) Gets the IsGlobal.
Property OriginDefineBy (p. 411) Gets or sets the origin
define by.
Property OriginLocation (p. 411) Gets or sets the origin
location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Property OriginX (p. 412) Gets or sets the origin X


coordinate.
Property OriginY (p. 412) Gets or sets the origin Y
coordinate.
Property OriginZ (p. 412) Gets or sets the origin Z
coordinate.
Property PrimaryAxis (p. 412) Gets or sets the
PrimaryAxis.
Property PrimaryAxisDefineBy (p. 412) Gets or sets the
PrimaryAxisDefineBy.
Property PrimaryAxisDirection (p. 412) Gets or sets the Principal
Axis Direction.
Property PrimaryAxisLocation (p. 413) Gets or sets the principal
axis geometry selection.
Property SecondaryAxis (p. 413) Gets or sets the
SecondaryAxis.
Property SecondaryAxisDefineBy (p. 413) Gets or sets the
SecondaryAxisDefineBy.
Property SecondaryAxisDirection (p. 413) Gets the Secondary Axis
Direction.
Property SecondaryAxisLocation (p. 413) Gets or sets the
orientation about
principal axis geometry
selection.
Property Suppressed (p. 413) Gets or sets the
Suppressed.
Property TransformationCount (p. 414) Gets the number of
transformations.
Property TransformedConfiguration (p. 414) Gets the
TransformedConfiguration.
Property XAxisData (p. 414) Gets the XAxisData.
Property YAxisData (p. 414) Gets the YAxisData.
Property ZAxisData (p. 414) Gets the ZAxisData.
Method AddComment() (p. 414) Creates a new child
Comment.
Method AddFigure() (p. 415) Creates a new child
Figure.
Method AddImage(string) (p. 415) Creates a new child
Image. If a filePath is
provided, the image will
be loaded from that file,
if not, the image will be
a screen capture of the
Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
Ansys.ACT.Automation.Mechanical Namespace

Method AddTransformation(TransformationType, Adds a new


CoordinateSystemAxisType) (p. 415) transformation.
Method CreateConstructionSurface() (p. 415) Run the
CreateConstructionSurface
action.
Method CreateSectionPlane() (p. 416) Run the
CreateSectionPlane
action.
Method Delete() (p. 416) Run the Delete action.
Method FlipX() (p. 416) Flips the X Axis of the
coordinate system
Method FlipY() (p. 416) Flips the Y Axis of the
coordinate system
Method FlipZ() (p. 416) Flips the Z Axis of the
coordinate system
Method GetChildren<ChildrenType>(bool, IList<ChildrenType>) (p. 416) Gets the list of children,
filtered by type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children,
IList<IDataModelObject>) (p. 417) filtered by type.
Method GetTransformationValue(uint) (p. 417) Gets the value of a
transformation.
Method MoveTransformationDown(uint) (p. 418) Moves a transformation
down.
Method MoveTransformationUp(uint) (p. 418) Moves a transformation
up.
Method OffsetX() (p. 418) Creates an offset in the X
Axis direction of the
coordinate system
Method OffsetX(object) (p. 418) Creates an offset in the X
Axis direction of the
coordinate system
Method OffsetY() (p. 419) Creates an offset in the Y
Axis direction of the
coordinate system
Method OffsetY(object) (p. 419) Creates an offset in the Y
Axis direction of the
coordinate system
Method OffsetZ() (p. 419) Creates an offset in the Z
Axis direction of the
coordinate system
Method OffsetZ(object) (p. 419) Creates an offset in the Z
Axis direction of the
coordinate system
Method RemoveTransformation(uint) (p. 419) Removes a tranformation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Method RotateX() (p. 420) Creates a rotation about


the X Axis of the
coordinate system
Method RotateX(object) (p. 420) Creates a rotation about
the X Axis of the
coordinate system
Method RotateY() (p. 420) Creates a rotation about
the Y Axis of the
coordinate system
Method RotateY(object) (p. 420) Creates a rotation about
the Y Axis of the
coordinate system
Method RotateZ() (p. 421) Creates a rotation about
the Z Axis of the
coordinate system
Method RotateZ(object) (p. 421) Creates a rotation about
the Z Axis of the
coordinate system
Method SetCoordinateSystemOriginAtCenterOfMass(IList<IBaseGeoBody>, Sets origin of the
IList<PointMass>, IList<DistributedMass>) (p. 421) coordinate system at the
center of mass
Method SetOriginLocation(Quantity, Quantity, Quantity) (p. 422) Changes the origin
location.
Method SetPrimaryAxisUsingCenterOfMass() (p. 422) Sets the primary axis
using a 1 or 2 point
selection and the center
of mass
Method SetTransformationValue(uint, object) (p. 422) Sets the value of a
transformation.

APDLName
Gets or sets the APDLName.

Declaration Syntax
public string APDLName { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystemID
Gets or sets the CoordinateSystemID.

Declaration Syntax
public int CoordinateSystemID { set;get; }

CoordinateSystemIDGeneration
Gets or sets the CoordinateSystemIDGeneration.

Declaration Syntax
public AutomaticOrManual CoordinateSystemIDGeneration { set;get; }

CoordinateSystemType
Gets or sets the CoordinateSystemType.

Declaration Syntax
public CoordinateSystemTypeEnum CoordinateSystemType { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

GloballyAvailable
Gets or sets the GloballyAvailable.

Declaration Syntax
public bool GloballyAvailable { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCoordinateSystemAuto InternalObject { get; }

IsGlobal
Gets the IsGlobal.

Declaration Syntax
public bool IsGlobal { get; }

OriginDefineBy
Gets or sets the origin define by.

Declaration Syntax
public CoordinateSystemAlignmentType OriginDefineBy { set;get; }

OriginLocation
Gets or sets the origin location.

Declaration Syntax
public ISelectionInfo OriginLocation { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
Ansys.ACT.Automation.Mechanical Namespace

OriginX
Gets or sets the origin X coordinate.

Declaration Syntax
public Quantity OriginX { set;get; }

OriginY
Gets or sets the origin Y coordinate.

Declaration Syntax
public Quantity OriginY { set;get; }

OriginZ
Gets or sets the origin Z coordinate.

Declaration Syntax
public Quantity OriginZ { set;get; }

PrimaryAxis
Gets or sets the PrimaryAxis.

Declaration Syntax
public CoordinateSystemAxisType PrimaryAxis { set;get; }

PrimaryAxisDefineBy
Gets or sets the PrimaryAxisDefineBy.

Declaration Syntax
public CoordinateSystemAlignmentType PrimaryAxisDefineBy { set;get; }

PrimaryAxisDirection
Gets or sets the Principal Axis Direction.

Declaration Syntax
public Vector3D PrimaryAxisDirection { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

PrimaryAxisLocation
Gets or sets the principal axis geometry selection.

Declaration Syntax
public ISelectionInfo PrimaryAxisLocation { set;get; }

SecondaryAxis
Gets or sets the SecondaryAxis.

Declaration Syntax
public CoordinateSystemAxisType SecondaryAxis { set;get; }

SecondaryAxisDefineBy
Gets or sets the SecondaryAxisDefineBy.

Declaration Syntax
public CoordinateSystemAlignmentType SecondaryAxisDefineBy { set;get; }

SecondaryAxisDirection
Gets the Secondary Axis Direction.

Declaration Syntax
public Vector3D SecondaryAxisDirection { set;get; }

SecondaryAxisLocation
Gets or sets the orientation about principal axis geometry selection.

Declaration Syntax
public ISelectionInfo SecondaryAxisLocation { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
Ansys.ACT.Automation.Mechanical Namespace

TransformationCount
Gets the number of transformations.

Declaration Syntax
public uint TransformationCount { get; }

TransformedConfiguration
Gets the TransformedConfiguration.

Declaration Syntax
public string TransformedConfiguration { get; }

XAxisData
Gets the XAxisData.

Declaration Syntax
public string XAxisData { get; }

YAxisData
Gets the YAxisData.

Declaration Syntax
public string YAxisData { get; }

ZAxisData
Gets the ZAxisData.

Declaration Syntax
public string ZAxisData { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddTransformation(TransformationType, CoordinateSystemAxisType)
Adds a new transformation.

Declaration Syntax
public virtual void AddTransformation(TransformationType trans, CoordinateSystemAxisType axis)

Parameters
trans(TransformationType)

No details are provided for this entry.

axis(CoordinateSystemAxisType)

No details are provided for this entry.

CreateConstructionSurface()
Run the CreateConstructionSurface action.

Declaration Syntax
public virtual void CreateConstructionSurface()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
Ansys.ACT.Automation.Mechanical Namespace

CreateSectionPlane()
Run the CreateSectionPlane action.

Declaration Syntax
public virtual void CreateSectionPlane()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

FlipX()
Flips the X Axis of the coordinate system

Declaration Syntax
public virtual void FlipX()

FlipY()
Flips the Y Axis of the coordinate system

Declaration Syntax
public virtual void FlipY()

FlipZ()
Flips the Z Axis of the coordinate system

Declaration Syntax
public virtual void FlipZ()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetTransformationValue(uint)
Gets the value of a transformation.

Declaration Syntax
public virtual object GetTransformationValue(uint index)

Parameters
index(uint)

Index of the transformation (First transformation is 1).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 417
Ansys.ACT.Automation.Mechanical Namespace

MoveTransformationDown(uint)
Moves a transformation down.

Declaration Syntax
public virtual void MoveTransformationDown(uint index)

Parameters
index(uint)

Index of the transformation (First transformation is 1).

MoveTransformationUp(uint)
Moves a transformation up.

Declaration Syntax
public virtual void MoveTransformationUp(uint index)

Parameters
index(uint)

Index of the transformation (First transformation is 1).

OffsetX()
Creates an offset in the X Axis direction of the coordinate system

Declaration Syntax
public virtual void OffsetX()

OffsetX(object)
Creates an offset in the X Axis direction of the coordinate system

Declaration Syntax
public virtual void OffsetX(object value)

Parameters
value(object)

Value of the offset.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
418 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

OffsetY()
Creates an offset in the Y Axis direction of the coordinate system

Declaration Syntax
public virtual void OffsetY()

OffsetY(object)
Creates an offset in the Y Axis direction of the coordinate system

Declaration Syntax
public virtual void OffsetY(object value)

Parameters
value(object)

Value of the offset.

OffsetZ()
Creates an offset in the Z Axis direction of the coordinate system

Declaration Syntax
public virtual void OffsetZ()

OffsetZ(object)
Creates an offset in the Z Axis direction of the coordinate system

Declaration Syntax
public virtual void OffsetZ(object value)

Parameters
value(object)

Value of the offset.

RemoveTransformation(uint)
Removes a tranformation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 419
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void RemoveTransformation(uint index)

Parameters
index(uint)

No details are provided for this entry.

RotateX()
Creates a rotation about the X Axis of the coordinate system

Declaration Syntax
public virtual void RotateX()

RotateX(object)
Creates a rotation about the X Axis of the coordinate system

Declaration Syntax
public virtual void RotateX(object value)

Parameters
value(object)

Value of the Rotation.

RotateY()
Creates a rotation about the Y Axis of the coordinate system

Declaration Syntax
public virtual void RotateY()

RotateY(object)
Creates a rotation about the Y Axis of the coordinate system

Declaration Syntax
public virtual void RotateY(object value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
420 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystem

Parameters
value(object)

Value of the Rotation.

RotateZ()
Creates a rotation about the Z Axis of the coordinate system

Declaration Syntax
public virtual void RotateZ()

RotateZ(object)
Creates a rotation about the Z Axis of the coordinate system

Declaration Syntax
public virtual void RotateZ(object value)

Parameters
value(object)

Value of the Rotation.

SetCoordinateSystemOriginAtCenterOfMass(IList<IBaseGeoBody>,
IList<PointMass>, IList<DistributedMass>)
Sets origin of the coordinate system at the center of mass

Declaration Syntax
public virtual void SetCoordinateSystemOriginAtCenterOfMass(IList<IBaseGeoBody> geoBodies,
IList<PointMass> pointMasses, IList<DistributedMass> distributedMasses)

Parameters
geoBodies(IList<IBaseGeoBody>)

No details are provided for this entry.

pointMasses(IList<PointMass>)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 421
Ansys.ACT.Automation.Mechanical Namespace

distributedMasses(IList<DistributedMass>)

No details are provided for this entry.

SetOriginLocation(Quantity, Quantity, Quantity)


Changes the origin location.

Declaration Syntax
public virtual void SetOriginLocation(Quantity originX, Quantity originY, Quantity originZ)

Parameters
originX(Quantity)

No details are provided for this entry.

originY(Quantity)

No details are provided for this entry.

originZ(Quantity)

No details are provided for this entry.

SetPrimaryAxisUsingCenterOfMass()
Sets the primary axis using a 1 or 2 point selection and the center of mass

Declaration Syntax
public virtual void SetPrimaryAxisUsingCenterOfMass()

SetTransformationValue(uint, object)
Sets the value of a transformation.

Declaration Syntax
public virtual void SetTransformationValue(uint index, object value)

Parameters
index(uint)

Index of the transformation (First transformation is 1).

value(object)

Value of the transformation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
422 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystems

CoordinateSystems
Defines a CoordinateSystems.

Declaration Syntax
public class CoordinateSystems : DataModelObject, IFolderDataModelObject

Table 193: Members

Property Children (p. 423) Gets the list of children.


Property Comments (p. 424) Gets the list of associated
comments.
Property DataModelObjectCategory (p. 424) Gets the current
DataModelObject's category.
Property Figures (p. 424) Gets the list of associated
figures.
Property Images (p. 424) Gets the list of associated
images.
Property InternalObject (p. 424) Gets the internal object. For
advanced usage only.
Method AddComment() (p. 424) Creates a new child
Comment.
Method AddCoordinateSystem() (p. 425) Creates a new
CoordinateSystem
Method AddCoordinateSystemAtCenterOfMass(IList<IBaseGeoBody>, Creates a new
IList<PointMass>, IList<DistributedMass>) (p. 425) CoordinateSystem at the
center of mass
Method AddFigure() (p. 425) Creates a new child Figure.
Method AddImage(string) (p. 425) Creates a new child Image. If
a filePath is provided, the
image will be loaded from
that file, if not, the image will
be a screen capture of the
Geometry window.
Method GetChildren<ChildrenType>(bool, Gets the list of children,
IList<ChildrenType>) (p. 426) filtered by type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children,
IList<IDataModelObject>) (p. 426) filtered by type.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 423
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCoordinateSystemGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
424 of ANSYS, Inc. and its subsidiaries and affiliates.
CoordinateSystems

AddCoordinateSystem()
Creates a new CoordinateSystem

Declaration Syntax
public virtual CoordinateSystem AddCoordinateSystem()

AddCoordinateSystemAtCenterOfMass(IList<IBaseGeoBody>, IList<Point-
Mass>, IList<DistributedMass>)
Creates a new CoordinateSystem at the center of mass

Declaration Syntax
public virtual CoordinateSystem AddCoordinateSystemAtCenterOfMass(IList<IBaseGeoBody> geoBodies,
IList<PointMass> pointMasses, IList<DistributedMass> distributedMasses)

Parameters
geoBodies(IList<IBaseGeoBody>)

No details are provided for this entry.

pointMasses(IList<PointMass>)

No details are provided for this entry.

distributedMasses(IList<DistributedMass>)

No details are provided for this entry.

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 425
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
CornerCrack

CornerCrack
Defines a CornerCrack.

Declaration Syntax
public class CornerCrack : GenericCrack

Table 194: Members

Property BottomFaceNodes (p. 428) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 428) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 428) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 428) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 429) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 429) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 429) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 429) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 429) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 429) Gets the CrackShape.
Property CrackSourceType (p. 430) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 430) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 430) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 430) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 430) Gets or sets the FrontElementSize.
Property GrowthRate (p. 430) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 431) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 431) Gets or sets the LargestContourRadius.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 427
Ansys.ACT.Automation.Mechanical Namespace

Property Location (p. 431) Gets or sets the Location.


Property MajorRadius (p. 431) Gets or sets the MajorRadius.
Property MeshContours (p. 431) Gets or sets the MeshContours.
Property MinorRadius (p. 431) Gets or sets the MinorRadius.
Property SolutionContours (p. 432) Gets or sets the SolutionContours.
Property Suppressed (p. 432) Gets or sets the Suppressed.
Property Target1Nodes (p. 432) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 432) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 432) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 432) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 433) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
428 of ANSYS, Inc. and its subsidiaries and affiliates.
CornerCrack

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 429
Ansys.ACT.Automation.Mechanical Namespace

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
430 of ANSYS, Inc. and its subsidiaries and affiliates.
CornerCrack

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
Ansys.ACT.Automation.Mechanical Namespace

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
CoSimulationPin

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

CoSimulationPin
Defines a CoSimulationPin.

Declaration Syntax
public class CoSimulationPin : DataModelObject, IFolderDataModelObject

Table 195: Members

Property Children (p. 433) Gets the list of children.


Property DataModelObjectCategory (p. 433) Gets the current DataModelObject's
category.
Property DOF (p. 434) Gets or sets the DOF.
Property InternalObject (p. 434) Gets the internal object. For advanced usage
only.
Property JointType (p. 434) Gets or sets the Joint Type.
Property PinBehavior (p. 434) Gets or sets the Pin Behavior.
Property PinNature (p. 434) Gets or sets the Pin Nature.
Property Scope (p. 434) Gets or sets the Joint through Scope.
Property Suppressed (p. 435) Gets or sets the Suppressed.
Method Delete() (p. 435) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 435)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 435)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 433
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DOF
Gets or sets the DOF.

Declaration Syntax
public KinematicDOF DOF { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSimplorerPinAuto InternalObject { get; }

JointType
Gets or sets the Joint Type.

Declaration Syntax
public JointType JointType { set;get; }

PinBehavior
Gets or sets the Pin Behavior.

Declaration Syntax
public PinBehavior PinBehavior { set;get; }

PinNature
Gets or sets the Pin Nature.

Declaration Syntax
public PinNature PinNature { set;get; }

Scope
Gets or sets the Joint through Scope.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
434 of ANSYS, Inc. and its subsidiaries and affiliates.
CoSimulationPin

Declaration Syntax
public Joint Scope { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 435
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEl-


lipticalCrack instead.
Defines a Crack.

Declaration Syntax
public class Crack : GenericCrack

Table 196: Members

Property AlignWithFaceNormal (p. 437) Gets or sets the AlignWithFaceNormal.


Property BottomFaceNodes (p. 437) Gets or sets the BottomFaceNodes.
Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 438) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 438) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 438) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 438) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 438) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 438) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 439) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackShape (p. 439) Gets the CrackShape.
Property CrackSourceType (p. 439) Gets the CrackSourceType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
436 of ANSYS, Inc. and its subsidiaries and affiliates.
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.

Property DataModelObjectCategory (p. 562) Gets the current DataModelObject's


category.

(Inherited from GenericCrack (p. 560).)


Property FaceTopNodes (p. 439) Gets or sets the FaceTopNodes.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 439) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 439) Gets or sets the FractureAffectedZoneHeight.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 440) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 440) Gets or sets the LargestContourRadius.
Property Location (p. 440) Gets the Location.
Property MajorRadius (p. 440) Gets or sets the MajorRadius.
Property MeshContours (p. 440) Gets or sets the MeshContours.
Property MinorRadius (p. 440) Gets or sets the MinorRadius.
Property ProjectToNearestSurface (p. 441) Gets or sets the ProjectToNearestSurface.
Property SolutionContours (p. 441) Gets or sets the SolutionContours.
Property Suppressed (p. 441) Gets or sets the Suppressed.
Property Target1Nodes (p. 441) Gets or sets the Target1Nodes.
Property XScaleFactor (p. 441) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 441) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 442) Gets or sets the ZScaleFactor.

AlignWithFaceNormal
Gets or sets the AlignWithFaceNormal.

Declaration Syntax
public bool AlignWithFaceNormal { set;get; }

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 437
Ansys.ACT.Automation.Mechanical Namespace

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
438 of ANSYS, Inc. and its subsidiaries and affiliates.
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

FaceTopNodes
Gets or sets the FaceTopNodes.

Declaration Syntax
public string FaceTopNodes { set;get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public Quantity FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 439
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets the Location.

Declaration Syntax
public ISelectionInfo Location { get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
440 of ANSYS, Inc. and its subsidiaries and affiliates.
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.

ProjectToNearestSurface
Gets or sets the ProjectToNearestSurface.

Declaration Syntax
public bool ProjectToNearestSurface { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 441
Ansys.ACT.Automation.Mechanical Namespace

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

CrackInitiation
Defines a CrackInitiation.

Declaration Syntax
public class CrackInitiation : GenericCrack

Table 197: Members

Property BottomFaceNodes (p. 443) Gets or sets the BottomFaceNodes.


Property CenterXCoordinate (p. 443) Gets or sets the CenterXCoordinate.
Property CenterYCoordinate (p. 443) Gets or sets the CenterYCoordinate.
Property CenterZCoordinate (p. 443) Gets or sets the CenterZCoordinate.
Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property CoordinateSystem (p. 443) Gets or sets the CoordinateSystem.
Property CrackCenter (p. 444) Gets or sets the CrackCenter.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackOrientation (p. 444) Gets or sets the CrackOrientation.
Property CrackShape (p. 444) Gets or sets the CrackShape.
Property CrackSourceType (p. 444) Gets the CrackSourceType.
Property CriterionValue (p. 444) Gets or sets the CriterionValue.
Property DataModelObjectCategory (p. 444) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InitiationCriterion (p. 445) Gets the InitiationCriterion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
442 of ANSYS, Inc. and its subsidiaries and affiliates.
CrackInitiation

Property InternalObject (p. 445) Gets the internal object. For advanced usage
only.
Property Location (p. 445) Gets or sets the Location.
Property MajorRadius (p. 445) Gets or sets the MajorRadius.
Property MinorRadius (p. 445) Gets or sets the MinorRadius.
Property NamedSelection (p. 445) Gets or sets the NamedSelection.
Property ScopingMethod (p. 446) Gets or sets the ScopingMethod.
Property SolutionContours (p. 446) Gets or sets the SolutionContours.
Property Suppressed (p. 446) Gets or sets the Suppressed.
Property TopFaceNodes (p. 446) Gets or sets the TopFaceNodes.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CenterXCoordinate
Gets or sets the CenterXCoordinate.

Declaration Syntax
public Quantity CenterXCoordinate { set;get; }

CenterYCoordinate
Gets or sets the CenterYCoordinate.

Declaration Syntax
public Quantity CenterYCoordinate { set;get; }

CenterZCoordinate
Gets or sets the CenterZCoordinate.

Declaration Syntax
public Quantity CenterZCoordinate { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 443
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackCenter
Gets or sets the CrackCenter.

Declaration Syntax
public CrackCenter CrackCenter { set;get; }

CrackOrientation
Gets or sets the CrackOrientation.

Declaration Syntax
public CrackOrientation CrackOrientation { set;get; }

CrackShape
Gets or sets the CrackShape.

Declaration Syntax
public CrackShape CrackShape { set;get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

CriterionValue
Gets or sets the CriterionValue.

Declaration Syntax
public Quantity CriterionValue { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
444 of ANSYS, Inc. and its subsidiaries and affiliates.
CrackInitiation

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InitiationCriterion
Gets the InitiationCriterion.

Declaration Syntax
public InitiationCriterion InitiationCriterion { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

NamedSelection
Gets or sets the NamedSelection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 445
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public NamedSelection NamedSelection { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

Criterion
Defines a Criterion.

Declaration Syntax
public class Criterion : ImportedDataModelObject, IFolderDataModelObject

Table 198: Members

Property Children (p. 447) Gets the list of children.


Property Comments (p. 447) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
446 of ANSYS, Inc. and its subsidiaries and affiliates.
Criterion

Property DataModelObjectCategory (p. 447) Gets the current DataModelObject's category.


Property Figures (p. 447) Gets the list of associated figures.
Property Images (p. 448) Gets the list of associated images.
Property InternalObject (p. 448) Gets the internal object. For advanced usage only.
Property Suppressed (p. 448) Gets or sets the Suppressed.
Method AddComment() (p. 448) Creates a new child Comment.
Method AddFigure() (p. 448) Creates a new child Figure.
Method AddImage(string) (p. 448) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 449) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 449)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 449)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 447
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoCriterionAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
448 of ANSYS, Inc. and its subsidiaries and affiliates.
Criterion

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 449
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

CriterionConstraint
Defines a CriterionConstraint.

Declaration Syntax
public class CriterionConstraint : ResponseConstraint

Table 199: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property Criterion (p. 450) Gets or sets the Criterion.
Property DataModelObjectCategory (p. 451)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InitialValue (p. 451) Gets the InitialValue.
Property InternalObject (p. 451) Gets the internal object. For advanced usage only.
Property LowerBound (p. 451) Gets or sets the LowerBound.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)


Property UpperBound (p. 451) Gets or sets the UpperBound.

Criterion
Gets or sets the Criterion.

Declaration Syntax
public Criterion Criterion { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
450 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSection

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InitialValue
Gets the InitialValue.

Declaration Syntax
public double InitialValue { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

LowerBound
Gets or sets the LowerBound.

Declaration Syntax
public double LowerBound { set;get; }

UpperBound
Gets or sets the UpperBound.

Declaration Syntax
public double UpperBound { set;get; }

CrossSection
Defines a CrossSection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 451
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CrossSection : ImportedDataModelObject, IFolderDataModelObject

Table 200: Members

Property Children (p. 452) Gets the list of children.


Property Comments (p. 452) Gets the list of associated comments.
Property DataModelObjectCategory (p. 452) Gets the current DataModelObject's category.
Property Figures (p. 453) Gets the list of associated figures.
Property Images (p. 453) Gets the list of associated images.
Property InternalObject (p. 453) Gets the internal object. For advanced usage only.
Method AddComment() (p. 453) Creates a new child Comment.
Method AddFigure() (p. 453) Creates a new child Figure.
Method AddImage(string) (p. 453) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 454) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 454)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 454)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
452 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSection

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 453
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSections

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

CrossSections
Defines a CrossSections.

Declaration Syntax
public class CrossSections : DataModelObject, IFolderDataModelObject

Table 201: Members

Property Children (p. 456) Gets the list of children.


Property Comments (p. 456) Gets the list of associated comments.
Property DataModelObjectCategory (p. 456) Gets the current DataModelObject's category.
Property Figures (p. 456) Gets the list of associated figures.
Property Images (p. 456) Gets the list of associated images.
Property InternalObject (p. 457) Gets the internal object. For advanced usage
only.
Method AddChannelCrossSection() (p. 457) Creates a new ChannelCrossSection
Method AddCircularCrossSection() (p. 457) Creates a new CircularCrossSection
Method AddCircularTubeCrossSection() (p. 457) Creates a new CircularTubeCrossSection
Method AddComment() (p. 457) Creates a new child Comment.
Method AddFigure() (p. 457) Creates a new child Figure.
Method AddHatCrossSection() (p. 458) Creates a new HatCrossSection
Method AddHollowRectangularCrossSection() (p. 458) Creates a new HollowRectangularCrossSection
Method AddICrossSection() (p. 458) Creates a new ICrossSection
Method AddImage(string) (p. 458) Creates a new child Image. If a filePath is
provided, the image will be loaded from that
file, if not, the image will be a screen capture
of the Geometry window.
Method AddLCrossSection() (p. 458) Creates a new LCrossSection
Method AddRectangularCrossSection() (p. 459) Creates a new RectangularCrossSection

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 455
Ansys.ACT.Automation.Mechanical Namespace

Method AddTCrossSection() (p. 459) Creates a new TCrossSection


Method AddUserDefinedCrossSection() (p. 459) Creates a new UserDefinedCrossSection
Method AddZCrossSection() (p. 459) Creates a new ZCrossSection
Method Delete() (p. 459) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 459)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 460)
Method NameCrossSectionsUniquely() (p. 460) programmatically give each of the Cross
Section objects a unique name .

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
456 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSections

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionGroupAuto InternalObject { get; }

AddChannelCrossSection()
Creates a new ChannelCrossSection

Declaration Syntax
public virtual ChannelCrossSection AddChannelCrossSection()

AddCircularCrossSection()
Creates a new CircularCrossSection

Declaration Syntax
public virtual CircularCrossSection AddCircularCrossSection()

AddCircularTubeCrossSection()
Creates a new CircularTubeCrossSection

Declaration Syntax
public virtual CircularTubeCrossSection AddCircularTubeCrossSection()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 457
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddHatCrossSection()
Creates a new HatCrossSection

Declaration Syntax
public virtual HatCrossSection AddHatCrossSection()

AddHollowRectangularCrossSection()
Creates a new HollowRectangularCrossSection

Declaration Syntax
public virtual HollowRectangularCrossSection AddHollowRectangularCrossSection()

AddICrossSection()
Creates a new ICrossSection

Declaration Syntax
public virtual ICrossSection AddICrossSection()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddLCrossSection()
Creates a new LCrossSection

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
458 of ANSYS, Inc. and its subsidiaries and affiliates.
CrossSections

Declaration Syntax
public virtual LCrossSection AddLCrossSection()

AddRectangularCrossSection()
Creates a new RectangularCrossSection

Declaration Syntax
public virtual RectangularCrossSection AddRectangularCrossSection()

AddTCrossSection()
Creates a new TCrossSection

Declaration Syntax
public virtual TCrossSection AddTCrossSection()

AddUserDefinedCrossSection()
Creates a new UserDefinedCrossSection

Declaration Syntax
public virtual UserDefinedCrossSection AddUserDefinedCrossSection()

AddZCrossSection()
Creates a new ZCrossSection

Declaration Syntax
public virtual ZCrossSection AddZCrossSection()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 459
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

NameCrossSectionsUniquely()
programmatically give each of the Cross Section objects a unique name .

Declaration Syntax
public virtual void NameCrossSectionsUniquely()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
460 of ANSYS, Inc. and its subsidiaries and affiliates.
CyclicManufacturingConstraint

CyclicManufacturingConstraint
Defines a CyclicManufacturingConstraint.

Declaration Syntax
public class CyclicManufacturingConstraint : ManufacturingConstraint

Table 202: Members

Property Axis (p. 461) Gets or sets the Axis.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 461) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 462)Gets the current DataModelObject's
category.
Property InternalObject (p. 462) Gets the internal object. For advanced usage
only.
Property Location (p. 462) Gets or sets the Location.
Property NumberofSectors (p. 462) Gets or sets the NumberofSectors.
Property ScopingMethod (p. 462) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 461
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NumberofSectors
Gets or sets the NumberofSectors.

Declaration Syntax
public uint NumberofSectors { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

CyclicRegion
Defines a CyclicRegion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
462 of ANSYS, Inc. and its subsidiaries and affiliates.
CyclicRegion

Declaration Syntax
public class CyclicRegion : SymmetryGeneral

Table 203: Members

Property Children (p. 1189) Gets the list of children.

(Inherited from SymmetryGeneral (p. 1188).)


Property Comments (p. 1189) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1188).)


Property CoordinateSystem (p. 1190) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1188).)


Property DataModelObjectCategory (p. 463)Gets the current DataModelObject's
category.
Property Figures (p. 1190) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1188).)


Property HighBoundaryLocation (p. 1190) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property Images (p. 1190) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1188).)


Property InternalObject (p. 464) Gets the internal object. For advanced usage
only.
Property Location (p. 1191) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 1188).)


Property LowBoundaryLocation (p. 1191) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property ScopeMode (p. 1191) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1188).)


Property Suppressed (p. 1191) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1188).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 463
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

CylindricalCrack
Defines a CylindricalCrack.

Declaration Syntax
public class CylindricalCrack : GenericCrack

Table 204: Members

Property BottomFaceNodes (p. 465) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 465) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 465) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 466) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 466) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 466) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 466) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 466) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 466) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 467) Gets the CrackShape.
Property CrackSourceType (p. 467) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 467) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 467) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 467) Gets or sets the FractureAffectedZoneHeight.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
464 of ANSYS, Inc. and its subsidiaries and affiliates.
CylindricalCrack

Property FrontElementSize (p. 467) Gets or sets the FrontElementSize.


Property GrowthRate (p. 468) Gets or sets the GrowthRate.
Property Height (p. 468) Gets or sets the Height.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 468) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 468) Gets or sets the LargestContourRadius.
Property Location (p. 468) Gets or sets the Location.
Property MajorRadius (p. 468) Gets or sets the MajorRadius.
Property MeshContours (p. 469) Gets or sets the MeshContours.
Property MinorRadius (p. 469) Gets or sets the MinorRadius.
Property SolutionContours (p. 469) Gets or sets the SolutionContours.
Property Suppressed (p. 469) Gets or sets the Suppressed.
Property Target1Nodes (p. 469) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 469) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 470) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 470) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 470) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 465
Ansys.ACT.Automation.Mechanical Namespace

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
466 of ANSYS, Inc. and its subsidiaries and affiliates.
CylindricalCrack

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 467
Ansys.ACT.Automation.Mechanical Namespace

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

Height
Gets or sets the Height.

Declaration Syntax
public Quantity Height { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
468 of ANSYS, Inc. and its subsidiaries and affiliates.
CylindricalCrack

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 469
Ansys.ACT.Automation.Mechanical Namespace

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

DirectMorph
Defines a DirectMorph.

Declaration Syntax
public class DirectMorph : DataModelObject, IFolderDataModelObject

Table 205: Members

Property Children (p. 471) Gets the list of children.


Property DataModelObjectCategory (p. 471) Gets the current DataModelObject's
category.
Property DisplacementFile (p. 471) Gets or sets the DisplacementFile.
Property InternalObject (p. 471) Gets the internal object. For advanced
usage only.
Property Location (p. 471) Gets or sets the Location.
Property ScaleFactor (p. 472) Gets or sets the ScaleFactor.
Property Suppressed (p. 472) Gets or sets the Suppressed.
Method Clear() (p. 472) clear morph control
Method Delete() (p. 472) Run the Delete action.
Method Generate() (p. 472) Generate morph control

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
470 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectMorph

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.


IList<ChildrenType>) (p. 472)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 473)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DisplacementFile
Gets or sets the DisplacementFile.

Declaration Syntax
public string DisplacementFile { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSDirectMorphAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 471
Ansys.ACT.Automation.Mechanical Namespace

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public double ScaleFactor { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Clear()
clear morph control

Declaration Syntax
public virtual void Clear()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Generate()
Generate morph control

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
472 of ANSYS, Inc. and its subsidiaries and affiliates.
DisplacementConstraint

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

DisplacementConstraint
Defines a DisplacementConstraint.

Declaration Syntax
public class DisplacementConstraint : ResponseConstraint

Table 206: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 474)Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 473
Ansys.ACT.Automation.Mechanical Namespace

Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis


object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 474) Gets the internal object. For advanced usage only.
Property Location (p. 474) Gets or sets the Location.
Property ScopingMethod (p. 474) Gets or sets the ScopingMethod.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)


Property XComponentMax (p. 475) Gets or sets the XComponentMax.
Property YComponentMax (p. 475) Gets or sets the YComponentMax.
Property ZComponentMax (p. 475) Gets or sets the ZComponentMax.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
474 of ANSYS, Inc. and its subsidiaries and affiliates.
DistributedMass

XComponentMax
Gets or sets the XComponentMax.

Declaration Syntax
public Field XComponentMax { get; }

YComponentMax
Gets or sets the YComponentMax.

Declaration Syntax
public Field YComponentMax { get; }

ZComponentMax
Gets or sets the ZComponentMax.

Declaration Syntax
public Field ZComponentMax { get; }

DistributedMass
Defines a DistributedMass.

Declaration Syntax
public class DistributedMass : GenericPointMass

Table 207: Members

Property Children (p. 568) Gets the list of children.

(Inherited from GenericPointMass (p. 568).)


Property Comments (p. 569) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 568).)


Property DataModelObjectCategory (p. 476)Gets the current DataModelObject's category.
Property ElementAPDLName (p. 476) Gets or sets the ElementAPDLName.
Property Figures (p. 569) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 568).)


Property Images (p. 569) Gets the list of associated images.

(Inherited from GenericPointMass (p. 568).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 475
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 476) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 569) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 568).)


Property Location (p. 570) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 568).)


Property MassPerUnitArea (p. 476) Gets or sets the MassPerUnitArea.
Property MassType (p. 477) Gets or sets the MassType.
Property RemotePoint (p. 570) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 568).)


Property Suppressed (p. 477) Gets or sets the Suppressed.
Property TotalMass (p. 477) Gets or sets the TotalMass.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementAPDLName
Gets or sets the ElementAPDLName.

Declaration Syntax
public string ElementAPDLName { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

MassPerUnitArea
Gets or sets the MassPerUnitArea.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
476 of ANSYS, Inc. and its subsidiaries and affiliates.
DynamicComplianceConstraint

Declaration Syntax
public Quantity MassPerUnitArea { set;get; }

MassType
Gets or sets the MassType.

Declaration Syntax
public DistributedMassInputType MassType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TotalMass
Gets or sets the TotalMass.

Declaration Syntax
public Quantity TotalMass { set;get; }

DynamicComplianceConstraint
Defines a DynamicComplianceConstraint.

Declaration Syntax
public class DynamicComplianceConstraint : ResponseConstraint

Table 208: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property ComplianceLimit (p. 478) Gets or sets the ComplianceLimit.
Property DataModelObjectCategory (p. 478)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 478) Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
Ansys.ACT.Automation.Mechanical Namespace

Property MaximumValue (p. 478) Gets or sets the MaximumValue.


Property MinimumValue (p. 478) Gets or sets the MinimumValue.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

ComplianceLimit
Gets or sets the ComplianceLimit.

Declaration Syntax
public Field ComplianceLimit { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

MaximumValue
Gets or sets the MaximumValue.

Declaration Syntax
public Quantity MaximumValue { set;get; }

MinimumValue
Gets or sets the MinimumValue.

Declaration Syntax
public Quantity MinimumValue { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
EdgeCrack

EdgeCrack
Defines a EdgeCrack.

Declaration Syntax
public class EdgeCrack : GenericCrack

Table 209: Members

Property BottomFaceNodes (p. 480) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 480) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 480) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 480) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 481) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 481) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 481) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 481) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 481) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 481) Gets the CrackShape.
Property CrackSourceType (p. 482) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 482) Gets the current DataModelObject's
category.
Property Depth (p. 482) Gets or sets the Depth.
Property EndWidth (p. 482) Gets or sets the EndWidth.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 482) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 482) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 483) Gets or sets the FrontElementSize.
Property GrowthRate (p. 483) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 479
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 483) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 483) Gets or sets the LargestContourRadius.
Property Location (p. 483) Gets or sets the Location.
Property MeshContours (p. 483) Gets or sets the MeshContours.
Property MidWidth (p. 484) Gets or sets the MidWidth.
Property SolutionContours (p. 484) Gets or sets the SolutionContours.
Property StartWidth (p. 484) Gets or sets the StartWidth.
Property Suppressed (p. 484) Gets or sets the Suppressed.
Property Target1Nodes (p. 484) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 484) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 485) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 485) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 485) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
480 of ANSYS, Inc. and its subsidiaries and affiliates.
EdgeCrack

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

CrackShape
Gets the CrackShape.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 481
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Depth
Gets or sets the Depth.

Declaration Syntax
public Quantity Depth { set;get; }

EndWidth
Gets or sets the EndWidth.

Declaration Syntax
public Quantity EndWidth { set;get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
482 of ANSYS, Inc. and its subsidiaries and affiliates.
EdgeCrack

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MeshContours
Gets or sets the MeshContours.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 483
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int MeshContours { set;get; }

MidWidth
Gets or sets the MidWidth.

Declaration Syntax
public Quantity MidWidth { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

StartWidth
Gets or sets the StartWidth.

Declaration Syntax
public Quantity StartWidth { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
484 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementOrientation

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

ElementOrientation
Defines a ElementOrientation.

Declaration Syntax
public class ElementOrientation : ImportedDataModelObject, IFolderDataModelObject

Table 210: Members

Property AxisEdgeOrientation (p. 486) Gets or sets the AxisEdgeOrientation.


Property AxisSurfaceOrientation (p. 486) Gets or sets the AxisSurfaceOrientation.
Property BodyLocation (p. 486) Gets or sets the BodyLocation.
Property Children (p. 487) Gets the list of children.
Property Comments (p. 487) Gets the list of associated comments.
Property CoordinateSystem (p. 487) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 487) Gets the current DataModelObject's category.
Property EdgeLocation (p. 487) Gets or sets the EdgeLocation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 485
Ansys.ACT.Automation.Mechanical Namespace

Property Figures (p. 487) Gets the list of associated figures.


Property Images (p. 488) Gets the list of associated images.
Property InternalObject (p. 488) Gets the internal object. For advanced usage only.
Property OrientationGuideDefinedBy (p. 488) Gets or sets the OrientationGuideDefinedBy.
Property Suppressed (p. 488) Gets or sets the Suppressed.
Property SurfaceLocation (p. 488) Gets or sets the SurfaceLocation.
Method AddComment() (p. 488) Creates a new child Comment.
Method AddFigure() (p. 489) Creates a new child Figure.
Method AddImage(string) (p. 489) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 489) Run the Delete action.
Method GenerateOrientations() (p. 489) Runs the GenerateOrientations action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 489)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 490)

AxisEdgeOrientation
Gets or sets the AxisEdgeOrientation.

Declaration Syntax
public ElementOrientationAxisType AxisEdgeOrientation { set;get; }

AxisSurfaceOrientation
Gets or sets the AxisSurfaceOrientation.

Declaration Syntax
public ElementOrientationAxisType AxisSurfaceOrientation { set;get; }

BodyLocation
Gets or sets the BodyLocation.

Declaration Syntax
public ISelectionInfo BodyLocation { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
486 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementOrientation

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EdgeLocation
Gets or sets the EdgeLocation.

Declaration Syntax
public ISelectionInfo EdgeLocation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 487
Ansys.ACT.Automation.Mechanical Namespace

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSElementOrientationAuto InternalObject { get; }

OrientationGuideDefinedBy
Gets or sets the OrientationGuideDefinedBy.

Declaration Syntax
public ElementOrientationGuide OrientationGuideDefinedBy { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

SurfaceLocation
Gets or sets the SurfaceLocation.

Declaration Syntax
public ISelectionInfo SurfaceLocation { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
488 of ANSYS, Inc. and its subsidiaries and affiliates.
ElementOrientation

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GenerateOrientations()
Runs the GenerateOrientations action.

Declaration Syntax
public virtual void GenerateOrientations()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 489
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

EllipticalCrack
Defines a EllipticalCrack.

Declaration Syntax
public class EllipticalCrack : GenericCrack

Table 211: Members

Property BottomFaceNodes (p. 492) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 492) Gets or sets the CircumferentialDivisions.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
490 of ANSYS, Inc. and its subsidiaries and affiliates.
EllipticalCrack

Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 492) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 492) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 492) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 492) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 493) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 493) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 493) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 493) Gets the CrackShape.
Property CrackSourceType (p. 493) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 493) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 494) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 494) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 494) Gets or sets the FrontElementSize.
Property GrowthRate (p. 494) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 494) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 494) Gets or sets the LargestContourRadius.
Property Location (p. 495) Gets or sets the Location.
Property MajorRadius (p. 495) Gets or sets the MajorRadius.
Property MeshContours (p. 495) Gets or sets the MeshContours.
Property MinorRadius (p. 495) Gets or sets the MinorRadius.
Property SolutionContours (p. 495) Gets or sets the SolutionContours.
Property Suppressed (p. 495) Gets or sets the Suppressed.
Property Target1Nodes (p. 496) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 496) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 496) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 496) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 496) Gets or sets the ZScaleFactor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 491
Ansys.ACT.Automation.Mechanical Namespace

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
492 of ANSYS, Inc. and its subsidiaries and affiliates.
EllipticalCrack

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 493
Ansys.ACT.Automation.Mechanical Namespace

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
494 of ANSYS, Inc. and its subsidiaries and affiliates.
EllipticalCrack

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 495
Ansys.ACT.Automation.Mechanical Namespace

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

EndRelease
Defines a EndRelease.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
496 of ANSYS, Inc. and its subsidiaries and affiliates.
EndRelease

Declaration Syntax
public class EndRelease : DataModelObject, IFolderDataModelObject

Table 212: Members

Property Behavior (p. 497) Gets or sets the Behavior.


Property Children (p. 498) Gets the list of children.
Property Comments (p. 498) Gets the list of associated comments.
Property CoordinateSystem (p. 498) Gets or sets the Coordinate System.
Property DataModelObjectCategory (p. 498) Gets the current DataModelObject's category.
Property EdgeLocation (p. 498) Gets or sets the EdgeLocation.
Property Figures (p. 498) Gets the list of associated figures.
Property Images (p. 499) Gets the list of associated images.
Property IndependentEdges (p. 499) Gets or sets the IndependentEdges.
Property InternalObject (p. 499) Gets the internal object. For advanced usage only.
Property RotationX (p. 499) Gets or sets the RotationX.
Property RotationY (p. 499) Gets or sets the RotationY.
Property RotationZ (p. 499) Gets or sets the RotationZ.
Property Suppressed (p. 500) Gets or sets the Suppressed.
Property TranslationX (p. 500) Gets or sets the TranslationX.
Property TranslationY (p. 500) Gets or sets the TranslationY.
Property TranslationZ (p. 500) Gets or sets the TranslationZ.
Property VertexLocation (p. 500) Gets or sets the VertexLocation.
Method AddComment() (p. 500) Creates a new child Comment.
Method AddFigure() (p. 501) Creates a new child Figure.
Method AddImage(string) (p. 501) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 501) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 501)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 502)

Behavior
Gets or sets the Behavior.

Declaration Syntax
public BeamEndReleaseBehavior Behavior { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 497
Ansys.ACT.Automation.Mechanical Namespace

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the Coordinate System.

Declaration Syntax
public ICoordinateSystemSelection CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EdgeLocation
Gets or sets the EdgeLocation.

Declaration Syntax
public ISelectionInfo EdgeLocation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
498 of ANSYS, Inc. and its subsidiaries and affiliates.
EndRelease

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

IndependentEdges
Gets or sets the IndependentEdges.

Declaration Syntax
public bool IndependentEdges { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSBeamEndReleaseAuto InternalObject { get; }

RotationX
Gets or sets the RotationX.

Declaration Syntax
public FixedOrFree RotationX { set;get; }

RotationY
Gets or sets the RotationY.

Declaration Syntax
public FixedOrFree RotationY { set;get; }

RotationZ
Gets or sets the RotationZ.

Declaration Syntax
public FixedOrFree RotationZ { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 499
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TranslationX
Gets or sets the TranslationX.

Declaration Syntax
public FixedOrFree TranslationX { set;get; }

TranslationY
Gets or sets the TranslationY.

Declaration Syntax
public FixedOrFree TranslationY { set;get; }

TranslationZ
Gets or sets the TranslationZ.

Declaration Syntax
public FixedOrFree TranslationZ { set;get; }

VertexLocation
Gets or sets the VertexLocation.

Declaration Syntax
public ISelectionInfo VertexLocation { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
500 of ANSYS, Inc. and its subsidiaries and affiliates.
EndRelease

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 501
Ansys.ACT.Automation.Mechanical Namespace

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ExpansionSettings
Defines a ExpansionSettings.

Declaration Syntax
public class ExpansionSettings : DataModelObject, IFolderDataModelObject

Table 213: Members

Property Children (p. 503) Gets the list of children.


Property CleanupOptionalFiles (p. 503) Gets or sets the
CleanupOptionalFiles.
Property Comments (p. 504) Gets the list of associated comments.
Property CondensedPartExpansionType (p. 504) Gets or sets the
CondensedPartExpansionType.
Property DataModelObjectCategory (p. 504) Gets the current DataModelObject's
category.
Property ExpandAfterUsePassFailure (p. 504) Gets or sets the
ExpandAfterUsePassFailure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
502 of ANSYS, Inc. and its subsidiaries and affiliates.
ExpansionSettings

Property Figures (p. 504) Gets the list of associated figures.


Property GeneralMiscellaneous (p. 504) Gets or sets the
GeneralMiscellaneous.
Property Images (p. 505) Gets the list of associated images.
Property InternalObject (p. 505) Gets the internal object. For
advanced usage only.
Property NodalForces (p. 505) Gets or sets the NodalForces.
Property Strain (p. 505) Gets or sets the Strain.
Property Stress (p. 505) Gets or sets the Stress.
Property Suppressed (p. 505) Gets or sets the Suppressed.
Method AddComment() (p. 506) Creates a new child Comment.
Method AddFigure() (p. 506) Creates a new child Figure.
Method AddImage(string) (p. 506) Creates a new child Image. If a
filePath is provided, the image will
be loaded from that file, if not, the
image will be a screen capture of the
Geometry window.
Method ClearGeneratedData() (p. 506) Run the ClearGeneratedData action.
Method Delete() (p. 506) Run the Delete action.
Method EvaluateAllResults() (p. 507) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 507) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 507) type.
Method GetCompletedExpansionState(CondensedPart) (p. 508) Gets the completed expansion state
of a given Condensed Part
Method GetExpansionState(CondensedPart) (p. 508) Gets the requested expansion state
of a given Condensed Part
Method PerformExpansionPass() (p. 508) Run the PerformExpansionPass
action.
Method SetExpansionState(CondensedPart, Sets the requested expansion state
CondensedPartExpansionState) (p. 508) of a given Condensed Part

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

CleanupOptionalFiles
Gets or sets the CleanupOptionalFiles.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 503
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool CleanupOptionalFiles { set;get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CondensedPartExpansionType
Gets or sets the CondensedPartExpansionType.

Declaration Syntax
public CondensedPartExpansionType CondensedPartExpansionType { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ExpandAfterUsePassFailure
Gets or sets the ExpandAfterUsePassFailure.

Declaration Syntax
public bool ExpandAfterUsePassFailure { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GeneralMiscellaneous
Gets or sets the GeneralMiscellaneous.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
504 of ANSYS, Inc. and its subsidiaries and affiliates.
ExpansionSettings

Declaration Syntax
public bool GeneralMiscellaneous { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExpansionSettingsAuto InternalObject { get; }

NodalForces
Gets or sets the NodalForces.

Declaration Syntax
public OutputControlsNodalForcesType NodalForces { set;get; }

Strain
Gets or sets the Strain.

Declaration Syntax
public bool Strain { set;get; }

Stress
Gets or sets the Stress.

Declaration Syntax
public bool Stress { set;get; }

Suppressed
Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 505
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
506 of ANSYS, Inc. and its subsidiaries and affiliates.
ExpansionSettings

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 507
Ansys.ACT.Automation.Mechanical Namespace

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetCompletedExpansionState(CondensedPart)
Gets the completed expansion state of a given Condensed Part

Declaration Syntax
public virtual CondensedPartExpansionState GetCompletedExpansionState(CondensedPart condensed-
Part)

Parameters
condensedPart(CondensedPart)

No details are provided for this entry.

GetExpansionState(CondensedPart)
Gets the requested expansion state of a given Condensed Part

Declaration Syntax
public virtual CondensedPartExpansionState GetExpansionState(CondensedPart condensedPart)

Parameters
condensedPart(CondensedPart)

No details are provided for this entry.

PerformExpansionPass()
Run the PerformExpansionPass action.

Declaration Syntax
public virtual void PerformExpansionPass()

SetExpansionState(CondensedPart, CondensedPartExpansionState)
Sets the requested expansion state of a given Condensed Part

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
508 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalEnhancedModel

Declaration Syntax
public virtual void SetExpansionState(CondensedPart condensedPart, CondensedPartExpansionState
state)

Parameters
condensedPart(CondensedPart)

No details are provided for this entry.

state(CondensedPartExpansionState)

No details are provided for this entry.

ExternalEnhancedModel
Defines a ExternalEnhancedModel.

Declaration Syntax
public class ExternalEnhancedModel : DataModelObject, IFolderDataModelObject

Table 214: Members

Property Children (p. 510) Gets the list of children.


Property Comments (p. 510) Gets the list of associated comments.
Property DataModelObjectCategory (p. 510) Gets the current DataModelObject's category.
Property Figures (p. 510) Gets the list of associated figures.
Property Images (p. 510) Gets the list of associated images.
Property InternalObject (p. 510) Gets the internal object. For advanced usage only.
Property LayerToDisplay (p. 511) Gets or sets the LayerToDisplay.
Property MaximumNumberOfLayers (p. 511) Gets the MaximumNumberOfLayers.
Property NonlinearEffects (p. 511) Gets or sets the NonlinearEffects.
Property Suppressed (p. 511) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 511) Gets or sets the ThermalStrainEffects.
Property Type (p. 511) Gets the Type.
Method AddComment() (p. 512) Creates a new child Comment.
Method AddFigure() (p. 512) Creates a new child Figure.
Method AddImage(string) (p. 512) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 512)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 509
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 513)
Method RegroupToDefault() (p. 513) Run the RegroupToDefault action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
510 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalEnhancedModel

Declaration Syntax
public IDSExternalEnhancedModelAuto InternalObject { get; }

LayerToDisplay
Gets or sets the LayerToDisplay.

Declaration Syntax
public int LayerToDisplay { set;get; }

MaximumNumberOfLayers
Gets the MaximumNumberOfLayers.

Declaration Syntax
public int MaximumNumberOfLayers { get; }

NonlinearEffects
Gets or sets the NonlinearEffects.

Declaration Syntax
public bool NonlinearEffects { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ThermalStrainEffects
Gets or sets the ThermalStrainEffects.

Declaration Syntax
public bool ThermalStrainEffects { set;get; }

Type
Gets the Type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 511
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ExternalEnhancedModelType Type { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
512 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalModelDataColl

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RegroupToDefault()
Run the RegroupToDefault action.

Declaration Syntax
public virtual void RegroupToDefault()

ExternalModelDataColl
Defines a ExternalModelDataColl.

Declaration Syntax
public class ExternalModelDataColl : ImportedDataModelObject, IReadOnlyList<ImportedObject>, IRe-
adOnlyCollection<ImportedObject>, IEnumerable<ImportedObject>, IEnumerable, IFolderDataModelObject

Table 215: Members

Property Children (p. 514) Gets the list of children.


Property Comments (p. 514) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 513
Ansys.ACT.Automation.Mechanical Namespace

Property Count (p. 514) Gets the NumberOfRows.


Property DataModelObjectCategory (p. 514) Gets the current DataModelObject's category.
Property Figures (p. 515) Gets the list of associated figures.
Property Images (p. 515) Gets the list of associated images.
Property InternalObject (p. 515) Gets the internal object. For advanced usage only.
Property Suppressed (p. 515) Gets or sets the Suppressed.
Method AddComment() (p. 515) Creates a new child Comment.
Method AddFigure() (p. 515) Creates a new child Figure.
Method AddImage(string) (p. 516) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 516) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 516)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 517)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Count
Gets the NumberOfRows.

Declaration Syntax
public int Count { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
514 of ANSYS, Inc. and its subsidiaries and affiliates.
ExternalModelDataColl

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 515
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
516 of ANSYS, Inc. and its subsidiaries and affiliates.
ExtrusionManufacturingConstraint

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ExtrusionManufacturingConstraint
Defines a ExtrusionManufacturingConstraint.

Declaration Syntax
public class ExtrusionManufacturingConstraint : ManufacturingConstraint

Table 216: Members

Property Axis (p. 518) Gets or sets the Axis.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 518) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 518)Gets the current DataModelObject's
category.
Property InternalObject (p. 518) Gets the internal object. For advanced usage
only.
Property Location (p. 518) Gets or sets the Location.
Property ScopingMethod (p. 519) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 517
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
518 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueCombination

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

FatigueCombination
Defines a FatigueCombination.

Declaration Syntax
public class FatigueCombination : DataModelObject, IEvaluateAllResults, IFolderDataModelObject

Table 217: Members

Property Children (p. 519) Gets the list of children.


Property Comments (p. 520) Gets the list of associated comments.
Property DataModelObjectCategory (p. 520) Gets the current DataModelObject's category.
Property Images (p. 520) Gets the list of associated images.
Property InternalObject (p. 520) Gets the internal object. For advanced usage only.
Method AddComment() (p. 520) Creates a new child Comment.
Method AddDamage() (p. 520) Creates a new FatigueDamage
Method AddImage(string) (p. 521) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 521) Run the Delete action.
Method EvaluateAllResults() (p. 521) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 521)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 522)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 519
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFatigueCombinationAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddDamage()
Creates a new FatigueDamage

Declaration Syntax
public virtual FatigueDamage AddDamage()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
520 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueCombination

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 521
Ansys.ACT.Automation.Mechanical Namespace

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

FatigueTool
Defines a FatigueTool.

Declaration Syntax
public class FatigueTool : DataModelObject, IFolderDataModelObject

Table 218: Members

Property AnalysisType (p. 524) Gets or sets the AnalysisType.


Property BinSize (p. 524) Gets or sets the BinSize.
Property Children (p. 524) Gets the list of children.
Property Comments (p. 524) Gets the list of associated comments.
Property CustomUnitsName (p. 524) Gets or sets the Custom Units Name.
Property DataModelObjectCategory (p. 524) Gets the current DataModelObject's category.
Property DisplayTime (p. 525) Gets or sets the DisplayTime.
Property ExposureDuration (p. 525) Gets or sets the ExposureDuration.
Property FatigueStrengthFactor (p. 525) Gets or sets the FatigueStrengthFactor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
522 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

Property Frequency (p. 525) Gets or sets the Frequency.


Property FrequencySelection (p. 525) Gets or sets the FrequencySelection.
Property HistoryDataLocation (p. 525) Gets or sets the HistoryDataLocation.
Property Images (p. 526) Gets the list of associated images.
Property InfiniteLife (p. 526) Gets or sets the InfiniteLife.
Property InternalObject (p. 526) Gets the internal object. For advanced usage only.
Property LoadingRatio (p. 526) Gets or sets the LoadingRatio.
Property LoadingType (p. 526) Gets or sets the LoadingType.
Property MaximumDataPointsToPlot (p. 526) Gets or sets the MaximumDataPointsToPlot.
Property MeanStressTheory (p. 527) Gets or sets the MeanStressTheory.
Property MethodSelection (p. 527) Gets or sets the MethodSelection.
Property OneCycleIsEqualTo (p. 527) Gets or sets the OneCycleIsEqualTo.
Property ResultsInput (p. 527) Gets or sets the ResultsInput.
Property ScaleFactor (p. 527) Gets or sets the ScaleFactor.
Property StressComponent (p. 527) Gets or sets the StressComponent.
Property UnitsName (p. 528) Gets or sets the UnitsName.
Property UseQuickRainflowCounting (p. 528) Gets or sets the UseQuickRainflowCounting.
Method AddBiaxialityIndication() (p. 528) Creates a new FatigueBiaxialityIndication
Method AddComment() (p. 528) Creates a new child Comment.
Method AddDamage() (p. 528) Creates a new FatigueDamage
Method AddDamageMatrix() (p. 528) Creates a new FatigueDamageMatrix
Method AddEquivalentAlternativeStress() (p. 529) Creates a new FatigueEquivalentAlternativeStress
Method AddFatigueSensitivity() (p. 529) Creates a new FatigueSensitivity
Method AddHysteresis() (p. 529) Creates a new FatigueHysteresis
Method AddImage(string) (p. 529) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddLife() (p. 529) Creates a new FatigueLife
Method AddRainflowMatrix() (p. 530) Creates a new FatigueRainflowMatrix
Method AddSafetyFactor() (p. 530) Creates a new FatigueSafetyFactor
Method ClearGeneratedData() (p. 530) Run the ClearGeneratedData action.
Method Delete() (p. 530) Run the Delete action.
Method DuplicateWithoutResults() (p. 530) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 530) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 531)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 531)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 523
Ansys.ACT.Automation.Mechanical Namespace

AnalysisType
Gets or sets the AnalysisType.

Declaration Syntax
public FatigueToolAnalysisType AnalysisType { set;get; }

BinSize
Gets or sets the BinSize.

Declaration Syntax
public int BinSize { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CustomUnitsName
Gets or sets the Custom Units Name.

Declaration Syntax
public string CustomUnitsName { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
524 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

DisplayTime
Gets or sets the DisplayTime.

Declaration Syntax
public Quantity DisplayTime { set;get; }

ExposureDuration
Gets or sets the ExposureDuration.

Declaration Syntax
public Quantity ExposureDuration { set;get; }

FatigueStrengthFactor
Gets or sets the FatigueStrengthFactor.

Declaration Syntax
public double FatigueStrengthFactor { set;get; }

Frequency
Gets or sets the Frequency.

Declaration Syntax
public Quantity Frequency { set;get; }

FrequencySelection
Gets or sets the FrequencySelection.

Declaration Syntax
public FatigueFrequencySelection FrequencySelection { set;get; }

HistoryDataLocation
Gets or sets the HistoryDataLocation.

Declaration Syntax
public string HistoryDataLocation { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 525
Ansys.ACT.Automation.Mechanical Namespace

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InfiniteLife
Gets or sets the InfiniteLife.

Declaration Syntax
public double InfiniteLife { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFatigueToolAuto InternalObject { get; }

LoadingRatio
Gets or sets the LoadingRatio.

Declaration Syntax
public double LoadingRatio { set;get; }

LoadingType
Gets or sets the LoadingType.

Declaration Syntax
public FatigueLoadType LoadingType { set;get; }

MaximumDataPointsToPlot
Gets or sets the MaximumDataPointsToPlot.

Declaration Syntax
public double MaximumDataPointsToPlot { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
526 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

MeanStressTheory
Gets or sets the MeanStressTheory.

Declaration Syntax
public MeanStressTheoryType MeanStressTheory { set;get; }

MethodSelection
Gets or sets the MethodSelection.

Declaration Syntax
public FatigueToolMethod MethodSelection { set;get; }

OneCycleIsEqualTo
Gets or sets the OneCycleIsEqualTo.

Declaration Syntax
public Quantity OneCycleIsEqualTo { set;get; }

ResultsInput
Gets or sets the ResultsInput.

Declaration Syntax
public FatigueToolResultsInputType ResultsInput { set;get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public double ScaleFactor { set;get; }

StressComponent
Gets or sets the StressComponent.

Declaration Syntax
public FatigueStressComponentType StressComponent { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 527
Ansys.ACT.Automation.Mechanical Namespace

UnitsName
Gets or sets the UnitsName.

Declaration Syntax
public LifeUnitsType UnitsName { set;get; }

UseQuickRainflowCounting
Gets or sets the UseQuickRainflowCounting.

Declaration Syntax
public bool UseQuickRainflowCounting { set;get; }

AddBiaxialityIndication()
Creates a new FatigueBiaxialityIndication

Declaration Syntax
public virtual FatigueBiaxialityIndication AddBiaxialityIndication()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddDamage()
Creates a new FatigueDamage

Declaration Syntax
public virtual FatigueDamage AddDamage()

AddDamageMatrix()
Creates a new FatigueDamageMatrix

Declaration Syntax
public virtual FatigueDamageMatrix AddDamageMatrix()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
528 of ANSYS, Inc. and its subsidiaries and affiliates.
FatigueTool

AddEquivalentAlternativeStress()
Creates a new FatigueEquivalentAlternativeStress

Declaration Syntax
public virtual FatigueEquivalentAlternativeStress AddEquivalentAlternativeStress()

AddFatigueSensitivity()
Creates a new FatigueSensitivity

Declaration Syntax
public virtual FatigueSensitivity AddFatigueSensitivity()

AddHysteresis()
Creates a new FatigueHysteresis

Declaration Syntax
public virtual FatigueHysteresis AddHysteresis()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddLife()
Creates a new FatigueLife

Declaration Syntax
public virtual FatigueLife AddLife()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 529
Ansys.ACT.Automation.Mechanical Namespace

AddRainflowMatrix()
Creates a new FatigueRainflowMatrix

Declaration Syntax
public virtual FatigueRainflowMatrix AddRainflowMatrix()

AddSafetyFactor()
Creates a new FatigueSafetyFactor

Declaration Syntax
public virtual FatigueSafetyFactor AddSafetyFactor()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DuplicateWithoutResults()
Run the DuplicateWithoutResults action.

Declaration Syntax
public virtual IDataModelObject DuplicateWithoutResults()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
530 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetection

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

FeatureDetection
Defines a FeatureDetection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 531
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class FeatureDetection : DataModelObject, IFolderDataModelObject

Table 219: Members

Property Children (p. 532) Gets the list of children.


Property Comments (p. 532) Gets the list of associated comments.
Property DataModelObjectCategory (p. 533) Gets the current DataModelObject's category.
Property Definition (p. 533) Get the FeatureDetectionDefinition object. This
object contains all the Feature Detection data like
Fillets, Holes, Chamfers detection.
Property Images (p. 533) Gets the list of associated images.
Property InternalObject (p. 533) Gets the internal object. For advanced usage only.
Property Location (p. 533) Gets or sets the Location.
Property NamedSelection (p. 533) Gets or sets the NamedSelection.
Property ScopingMethod (p. 534) Gets or sets the ScopingMethod.
Method AddComment() (p. 534) Creates a new child Comment.
Method AddImage(string) (p. 534) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 534) Run the ClearGeneratedData action.
Method Delete() (p. 534) Run the Delete action.
Method DetectFeatures() (p. 535) No details are provided for this entry.
Method EvaluateAllResults() (p. 535) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 535)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 535)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
532 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetection

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Definition
Get the FeatureDetectionDefinition object. This object contains all the Feature Detection data like
Fillets, Holes, Chamfers detection.

Declaration Syntax
public FeatureDetectionDefinition Definition { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFeatureDetectionAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NamedSelection
Gets or sets the NamedSelection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 533
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public NamedSelection NamedSelection { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
534 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetection

Declaration Syntax
public virtual void Delete()

DetectFeatures()
No details are provided for this entry.

Declaration Syntax
public virtual void DetectFeatures()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 535
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

FeatureDetectionDefinition
No details are provided for this entry.

Declaration Syntax
public class FeatureDetectionDefinition

Table 220: Members

Property FeatureDetectionCount (p. 537) Gets the number of Feature Detections


Method AddFeatureDetection(string, int, int, int, Add a FeatureDetection to the
double, double, double, double, FeatureDetection Definition
int) (p. 537)
Method DeleteFeatureDetection(uint) (p. 538) Delete a FeatureDetection from the Feature
Detection Definition
Method ExecuteDetectFeatures() (p. 539) No details are provided for this entry.
Method Export(string) (p. 539) Export Feature Detection Definition data to
Comma Separated Value (CSV) files
Method GetFeatureCriteriaAngle(uint) (p. 539) Gets the Angle property at given
FeatureDetection index and BaseCase index
Method GetFeatureCriteriaMaxBound(uint) (p. 539) Gets the Max-Bound property at given
FeatureDetection index and BaseCase index
Method GetFeatureCriteriaMinBound(uint) (p. 540) Gets the Min Bound property at given
FeatureDetection index and BaseCase index
Method GetFeatureCriteriaValue(uint) (p. 540) Gets the Value property at given
FeatureDetection index and BaseCase index
Method GetFeatureDetectionCriteria(uint) (p. 540) Gets the Feature Detection Criteria property
at given index
Method GetFeatureDetectionName(uint) (p. 541) Gets the FeatureDetection Name property at
given index
Method GetFeatureDetectionOperator(uint) (p. 541) Gets the Feature Detection Operator property
at given index

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
536 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetectionDefinition

Method GetFeatureDetectionTreatment(uint) (p. 541) Gets the Feature Detection Criteria property
at given index
Method GetFeatureDetectionType(uint) (p. 541) Gets the Feature Detection Type property at
given index
Method Import(string) (p. 542) Import Feature Detection Definition data from
Comma Separated Value (CSV) files
Method SetFeatureCriteriaAngle(uint, Sets the Angle property at given
double) (p. 542) FeatureDetection index and BaseCase index
Method SetFeatureCriteriaMaxBound(uint, Sets the Max Bound property at given
double) (p. 542) FeatureDetection index and BaseCase index
Method SetFeatureCriteriaMinBound(uint, Sets the Min Bound property at given
double) (p. 543) FeatureDetection index and BaseCase index
Method SetFeatureCriteriaValue(uint, Sets the Value property at given
double) (p. 543) FeatureDetection index and BaseCase index
Method SetFeatureDetectionCriteria(uint, Sets the Feature Detection Criteria property at
FeatureDetectionCriteria) (p. 543) given index
Method SetFeatureDetectionName(uint, Sets the FeatureDetection Name property at
string) (p. 544) given index
Method SetFeatureDetectionOperator(uint, Sets the Feature Detection Operator property
FeatureDetectionOperator) (p. 544) at given index
Method SetFeatureDetectionOptions(bool, bool, Set Feature Detection Solid / Sheet / Beta
bool) (p. 545) settings

Set solid option.>

Set solid option.>

Set solid option.>


Method SetFeatureDetectionTreatment(uint, Sets the Feature Detection Criteria property at
FeatureDetectionTreatment) (p. 545) given index
Method SetFeatureDetectionType(uint, Sets the Feature Detection Type property at
FeatureDetectionType) (p. 545) given index

FeatureDetectionCount
Gets the number of Feature Detections

Declaration Syntax
public uint FeatureDetectionCount { get; }

AddFeatureDetection(string, int, int, int, double, double, double, double,


int)
Add a FeatureDetection to the FeatureDetection Definition

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 537
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public void AddFeatureDetection(string name, int type, int criteria, int fdOperator, double critValue,
double angleValue, double minBound, double maxBound, int meshTreatment)

Parameters
name(string)

Name of the FeatureDetection

type(int)

Type of the FeatureDetection (0 for Fillet, 1 for Hole, )

criteria(int)

No details are provided for this entry.

fdOperator(int)

No details are provided for this entry.

critValue(double)

No details are provided for this entry.

angleValue(double)

No details are provided for this entry.

minBound(double)

No details are provided for this entry.

maxBound(double)

No details are provided for this entry.

meshTreatment(int)

No details are provided for this entry.

DeleteFeatureDetection(uint)
Delete a FeatureDetection from the Feature Detection Definition

Declaration Syntax
public void DeleteFeatureDetection(uint index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
538 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetectionDefinition

Parameters
index(uint)

Index of the FeatureDetection to delete

ExecuteDetectFeatures()
No details are provided for this entry.

Declaration Syntax
public void ExecuteDetectFeatures()

Export(string)
Export Feature Detection Definition data to Comma Separated Value (CSV) files

Declaration Syntax
public void Export(string filepath)

Parameters
filepath(string)

Complete filepath to exported CSV file

GetFeatureCriteriaAngle(uint)
Gets the Angle property at given FeatureDetection index and BaseCase index

Declaration Syntax
public double GetFeatureCriteriaAngle(uint index)

Parameters
index(uint)

FeatureDetection index (row)

GetFeatureCriteriaMaxBound(uint)
Gets the Max-Bound property at given FeatureDetection index and BaseCase index

Declaration Syntax
public double GetFeatureCriteriaMaxBound(uint index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 539
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(uint)

FeatureDetection index (row)

GetFeatureCriteriaMinBound(uint)
Gets the Min Bound property at given FeatureDetection index and BaseCase index

Declaration Syntax
public double GetFeatureCriteriaMinBound(uint index)

Parameters
index(uint)

FeatureDetection index (row)

GetFeatureCriteriaValue(uint)
Gets the Value property at given FeatureDetection index and BaseCase index

Declaration Syntax
public double GetFeatureCriteriaValue(uint index)

Parameters
index(uint)

FeatureDetection index (row)

GetFeatureDetectionCriteria(uint)
Gets the Feature Detection Criteria property at given index

Declaration Syntax
public FeatureDetectionCriteria GetFeatureDetectionCriteria(uint index)

Parameters
index(uint)

Index to get Feature Detection Type at

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
540 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetectionDefinition

GetFeatureDetectionName(uint)
Gets the FeatureDetection Name property at given index

Declaration Syntax
public string GetFeatureDetectionName(uint index)

Parameters
index(uint)

Index to get FeatureDetection Name at

GetFeatureDetectionOperator(uint)
Gets the Feature Detection Operator property at given index

Declaration Syntax
public FeatureDetectionOperator GetFeatureDetectionOperator(uint index)

Parameters
index(uint)

Index to get Feature Detection Type at

GetFeatureDetectionTreatment(uint)
Gets the Feature Detection Criteria property at given index

Declaration Syntax
public FeatureDetectionTreatment GetFeatureDetectionTreatment(uint index)

Parameters
index(uint)

Index to get Feature Detection Type at

GetFeatureDetectionType(uint)
Gets the Feature Detection Type property at given index

Declaration Syntax
public FeatureDetectionType GetFeatureDetectionType(uint index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 541
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(uint)

Index to get Feature Detection Type at

Import(string)
Import Feature Detection Definition data from Comma Separated Value (CSV) files

Declaration Syntax
public void Import(string filepath)

Parameters
filepath(string)

Complete filepath to CSV file to import from

SetFeatureCriteriaAngle(uint, double)
Sets the Angle property at given FeatureDetection index and BaseCase index

Declaration Syntax
public void SetFeatureCriteriaAngle(uint index, double value)

Parameters
index(uint)

FeatureDetection index (row)

value(double)

Angle value

SetFeatureCriteriaMaxBound(uint, double)
Sets the Max Bound property at given FeatureDetection index and BaseCase index

Declaration Syntax
public void SetFeatureCriteriaMaxBound(uint index, double value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
542 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetectionDefinition

Parameters
index(uint)

FeatureDetection index (row)

value(double)

Angle value

SetFeatureCriteriaMinBound(uint, double)
Sets the Min Bound property at given FeatureDetection index and BaseCase index

Declaration Syntax
public void SetFeatureCriteriaMinBound(uint index, double value)

Parameters
index(uint)

FeatureDetection index (row)

value(double)

Criteria Value

SetFeatureCriteriaValue(uint, double)
Sets the Value property at given FeatureDetection index and BaseCase index

Declaration Syntax
public void SetFeatureCriteriaValue(uint index, double value)

Parameters
index(uint)

FeatureDetection index (row)

value(double)

Criteria Value

SetFeatureDetectionCriteria(uint, FeatureDetectionCriteria)
Sets the Feature Detection Criteria property at given index

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 543
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public void SetFeatureDetectionCriteria(uint index, FeatureDetectionCriteria value)

Parameters
index(uint)

Index to set Feature Detection Type at

value(FeatureDetectionCriteria)

FeatureDetectionCriteria

SetFeatureDetectionName(uint, string)
Sets the FeatureDetection Name property at given index

Declaration Syntax
public void SetFeatureDetectionName(uint index, string name)

Parameters
index(uint)

Index to set FeatureDetection Name at

name(string)

Feature Detection Name string

SetFeatureDetectionOperator(uint, FeatureDetectionOperator)
Sets the Feature Detection Operator property at given index

Declaration Syntax
public void SetFeatureDetectionOperator(uint index, FeatureDetectionOperator value)

Parameters
index(uint)

Index to set Feature Detection Type at

value(FeatureDetectionOperator)

FeatureDetectionOperator

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
544 of ANSYS, Inc. and its subsidiaries and affiliates.
FeatureDetectionDefinition

SetFeatureDetectionOptions(bool, bool, bool)


Set Feature Detection Solid / Sheet / Beta settings

Set solid option.>

Set solid option.>

Set solid option.>

Declaration Syntax
public void SetFeatureDetectionOptions(bool isSolid, bool isSheet, bool isBeta)

Parameters
isSolid(bool)

No details are provided for this entry.

isSheet(bool)

No details are provided for this entry.

isBeta(bool)

No details are provided for this entry.

SetFeatureDetectionTreatment(uint, FeatureDetectionTreatment)
Sets the Feature Detection Criteria property at given index

Declaration Syntax
public void SetFeatureDetectionTreatment(uint index, FeatureDetectionTreatment value)

Parameters
index(uint)

Index to set Feature Detection Type at

value(FeatureDetectionTreatment)

FeatureDetectionTreatment

SetFeatureDetectionType(uint, FeatureDetectionType)
Sets the Feature Detection Type property at given index

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 545
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public void SetFeatureDetectionType(uint index, FeatureDetectionType value)

Parameters
index(uint)

Index to set Feature Detection Type at

value(FeatureDetectionType)

FeatureDetectionType.Fillet = 0, FeatureDetectionType.Hole = 1, FeatureDetectionType.Chamfer


= 2, FeatureDetectionType.Stamp = 3, FeatureDetectionType.Flange = 4, FeatureDetectionType.Hem
= 5, FeatureDetectionType.SolidFillet = 6, FeatureDetectionType.SolidConvexFillet = 7; FeatureDe-
tectionType.SolidConcaveFillet = 8, FeatureDetectionType.SolidHoles = 9;

Figure
Defines a Figure.

Declaration Syntax
public class Figure : DataModelObject, IFolderDataModelObject

Table 221: Members

Property Children (p. 546) Gets the list of children.


Property Comments (p. 547) Gets the list of associated comments.
Property DataModelObjectCategory (p. 547) Gets the current DataModelObject's
category.
Property InternalObject (p. 547) Gets the internal object. For advanced
usage only.
Property Text (p. 547) Gets or sets the Text.
Method AddComment() (p. 547) Creates a new child Comment.
Method Delete() (p. 547) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 548)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 548)

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
546 of ANSYS, Inc. and its subsidiaries and affiliates.
Figure

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFigureAuto InternalObject { get; }

Text
Gets or sets the Text.

Declaration Syntax
public string Text { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 547
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
548 of ANSYS, Inc. and its subsidiaries and affiliates.
Fracture

Fracture
Defines a Fracture.

Declaration Syntax
public class Fracture : DataModelObject, IFolderDataModelObject

Table 222: Members

Property Children (p. 550) Gets the list of children.


Property Comments (p. 550) Gets the list of associated comments.
Property DataModelObjectCategory (p. 550) Gets the current DataModelObject's
category.
Property Figures (p. 550) Gets the list of associated figures.
Property Images (p. 550) Gets the list of associated images.
Property InternalObject (p. 551) Gets the internal object. For advanced
usage only.
Property RemeshHexDominantToTetrahedralType (p. 551) Gets or sets the re-meshing approach, if
any, surrounding the crack.

Default: Off
Method AddArbitraryCrack() (p. 551) Creates a new ArbitraryCrack
Method AddComment() (p. 551) Creates a new child Comment.
Method AddContactDebonding() (p. 551) Creates a new ContactDebonding
Method AddCornerCrack() (p. 552) Creates a new CornerCrack
Method AddCrack() ***OBSOLETE*** Use the method Creates a new child Crack.
AddArbitraryCrack or AddSemiEllipticalCrack
instead. (p. 552)
Method AddCrackInitiation() (p. 552) Creates a new CrackInitiation
Method AddCylindricalCrack() (p. 552) Creates a new CylindricalCrack
Method AddEdgeCrack() (p. 552) Creates a new EdgeCrack
Method AddEllipticalCrack() (p. 552) Creates a new EllipticalCrack
Method AddFigure() (p. 553) Creates a new child Figure.
Method AddImage(string) (p. 553) Creates a new child Image. If a filePath is
provided, the image will be loaded from
that file, if not, the image will be a screen
capture of the Geometry window.
Method AddInterfaceDelamination() (p. 553) Creates a new InterfaceDelamination
Method AddPreMeshedCrack() (p. 553) Creates a new PreMeshedCrack
Method AddRingCrack() (p. 553) Creates a new RingCrack
Method AddSemiEllipticalCrack() (p. 554) Creates a new SemiEllipticalCrack
Method AddSMARTCrackGrowth() (p. 554) Creates a new SMARTCrackGrowth
Method AddThroughCrack() (p. 554) Creates a new ThroughCrack

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 549
Ansys.ACT.Automation.Mechanical Namespace

Method Delete() (p. 554) Run the Delete action.


Method GenerateAllCrackMesh() (p. 554) Run the GenerateAllCrackMesh action.
Method GenerateAllInterfaceDelamination() (p. 554) Generate all interfaces delamination from
an external model.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 555)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 555)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
550 of ANSYS, Inc. and its subsidiaries and affiliates.
Fracture

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSFractureGroupAuto InternalObject { get; }

RemeshHexDominantToTetrahedralType
Gets or sets the re-meshing approach, if any, surrounding the crack.

Default: Off

Declaration Syntax
public RemeshHexDominantToTetrahedral RemeshHexDominantToTetrahedralType { set;get; }

AddArbitraryCrack()
Creates a new ArbitraryCrack

Declaration Syntax
public virtual ArbitraryCrack AddArbitraryCrack()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddContactDebonding()
Creates a new ContactDebonding

Declaration Syntax
public virtual ContactDebonding AddContactDebonding()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 551
Ansys.ACT.Automation.Mechanical Namespace

AddCornerCrack()
Creates a new CornerCrack

Declaration Syntax
public virtual CornerCrack AddCornerCrack()

AddCrack() ***OBSOLETE*** Use the method AddArbitraryCrack or


AddSemiEllipticalCrack instead.
Creates a new child Crack.

Declaration Syntax
public virtual Crack AddCrack()

AddCrackInitiation()
Creates a new CrackInitiation

Declaration Syntax
public virtual CrackInitiation AddCrackInitiation()

AddCylindricalCrack()
Creates a new CylindricalCrack

Declaration Syntax
public virtual CylindricalCrack AddCylindricalCrack()

AddEdgeCrack()
Creates a new EdgeCrack

Declaration Syntax
public virtual EdgeCrack AddEdgeCrack()

AddEllipticalCrack()
Creates a new EllipticalCrack

Declaration Syntax
public virtual EllipticalCrack AddEllipticalCrack()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
552 of ANSYS, Inc. and its subsidiaries and affiliates.
Fracture

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddInterfaceDelamination()
Creates a new InterfaceDelamination

Declaration Syntax
public virtual InterfaceDelamination AddInterfaceDelamination()

AddPreMeshedCrack()
Creates a new PreMeshedCrack

Declaration Syntax
public virtual PreMeshedCrack AddPreMeshedCrack()

AddRingCrack()
Creates a new RingCrack

Declaration Syntax
public virtual RingCrack AddRingCrack()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 553
Ansys.ACT.Automation.Mechanical Namespace

AddSemiEllipticalCrack()
Creates a new SemiEllipticalCrack

Declaration Syntax
public virtual SemiEllipticalCrack AddSemiEllipticalCrack()

AddSMARTCrackGrowth()
Creates a new SMARTCrackGrowth

Declaration Syntax
public virtual SMARTCrackGrowth AddSMARTCrackGrowth()

AddThroughCrack()
Creates a new ThroughCrack

Declaration Syntax
public virtual ThroughCrack AddThroughCrack()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GenerateAllCrackMesh()
Run the GenerateAllCrackMesh action.

Declaration Syntax
public virtual void GenerateAllCrackMesh()

GenerateAllInterfaceDelamination()
Generate all interfaces delamination from an external model.

Declaration Syntax
public virtual void GenerateAllInterfaceDelamination()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
554 of ANSYS, Inc. and its subsidiaries and affiliates.
GeneralAxisymmetric

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GeneralAxisymmetric
Defines a GeneralAxisymmetric.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 555
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class GeneralAxisymmetric : ImportedDataModelObject, IFolderDataModelObject

Table 223: Members

Property Axis (p. 556) Gets or sets the Axis.


Property Children (p. 556) Gets the list of children.
Property Comments (p. 557) Gets the list of associated comments.
Property CoordinateSystem (p. 557) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 557) Gets the current DataModelObject's category.
Property EndPlane (p. 557) Gets or sets the EndPlane.
Property Figures (p. 557) Gets the list of associated figures.
Property Images (p. 557) Gets the list of associated images.
Property InternalObject (p. 558) Gets the internal object. For advanced usage only.
Property Location (p. 558) Gets or sets the Location.
Property NodalPlanes (p. 558) Gets or sets the NodalPlanes.
Property NodalPlanesVisible (p. 558) Gets or sets the NodalPlanesVisible.
Property StartPlane (p. 558) Gets or sets the StartPlane.
Property Suppressed (p. 558) Gets or sets the Suppressed.
Method AddComment() (p. 559) Creates a new child Comment.
Method AddFigure() (p. 559) Creates a new child Figure.
Method AddImage(string) (p. 559) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 559) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 559)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 560)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
556 of ANSYS, Inc. and its subsidiaries and affiliates.
GeneralAxisymmetric

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EndPlane
Gets or sets the EndPlane.

Declaration Syntax
public uint EndPlane { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 557
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeneralAxisymmetricAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NodalPlanes
Gets or sets the NodalPlanes.

Declaration Syntax
public uint NodalPlanes { set;get; }

NodalPlanesVisible
Gets or sets the NodalPlanesVisible.

Declaration Syntax
public NodalPlanesVisible NodalPlanesVisible { set;get; }

StartPlane
Gets or sets the StartPlane.

Declaration Syntax
public uint StartPlane { set;get; }

Suppressed
Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
558 of ANSYS, Inc. and its subsidiaries and affiliates.
GeneralAxisymmetric

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 559
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GenericCrack
Defines a GenericCrack.

Declaration Syntax
public abstract class GenericCrack : ImportedDataModelObject, IFolderDataModelObject

Table 224: Members

Property Children (p. 561) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
560 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericCrack

Property Comments (p. 561) Gets the list of associated comments.


Property CrackID (p. 561) Gets the CrackID.
Property DataModelObjectCategory (p. 562) Gets the current DataModelObject's category.
Property Figures (p. 562) Gets the list of associated figures.
Property Images (p. 562) Gets the list of associated images.
Property InternalObject (p. 562) Gets the internal object. For advanced usage only.
Method AddCommandSnippet() (p. 562) Creates a new CommandSnippet
Method AddComment() (p. 562) Creates a new child Comment.
Method AddFigure() (p. 563) Creates a new child Figure.
Method AddImage(string) (p. 563) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 563) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 563)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 564)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CrackID
Gets the CrackID.

Declaration Syntax
public int CrackID { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 561
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
562 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericCrack

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 563
Ansys.ACT.Automation.Mechanical Namespace

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GenericDelamination
Defines a GenericDelamination.

Declaration Syntax
public abstract class GenericDelamination : ImportedDataModelObject, IFolderDataModelObject

Table 225: Members

Property Children (p. 565) Gets the list of children.


Property Comments (p. 565) Gets the list of associated comments.
Property DataModelObjectCategory (p. 565) Gets the current DataModelObject's category.
Property Figures (p. 565) Gets the list of associated figures.
Property Images (p. 565) Gets the list of associated images.
Property InternalObject (p. 566) Gets the internal object. For advanced usage only.
Method AddCommandSnippet() (p. 566) Creates a new CommandSnippet
Method AddComment() (p. 566) Creates a new child Comment.
Method AddFigure() (p. 566) Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
564 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericDelamination

Method AddImage(string) (p. 566) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 567) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 567)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 567)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 565
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
566 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericDelamination

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 567
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GenericPointMass
Defines a GenericPointMass.

Declaration Syntax
public abstract class GenericPointMass : ImportedDataModelObject, IFolderDataModelObject

Table 226: Members

Property Children (p. 568) Gets the list of children.


Property Comments (p. 569) Gets the list of associated comments.
Property DataModelObjectCategory (p. 569) Gets the current DataModelObject's category.
Property Figures (p. 569) Gets the list of associated figures.
Property Images (p. 569) Gets the list of associated images.
Property InternalObject (p. 569) Gets the internal object. For advanced usage only.
Property IsDistributedMass (p. 569) Gets the IsDistributedMass.
Property Location (p. 570) Gets or sets the Geometry.
Property RemotePoint (p. 570) Gets the remote point associated to the point mass.
Method AddCommandSnippet() (p. 570) Creates a new CommandSnippet
Method AddComment() (p. 570) Creates a new child Comment.
Method AddFigure() (p. 570) Creates a new child Figure.
Method AddImage(string) (p. 570) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 571) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 571)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 571)

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
568 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericPointMass

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

IsDistributedMass
Gets the IsDistributedMass.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 569
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool IsDistributedMass { get; }

Location
Gets or sets the Geometry.

Declaration Syntax
public ISelectionInfo Location { set;get; }

RemotePoint
Gets the remote point associated to the point mass.

Declaration Syntax
public RemotePoint RemotePoint { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
570 of ANSYS, Inc. and its subsidiaries and affiliates.
GenericPointMass

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 571
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Geometry
Defines a Geometry.

Declaration Syntax
public class Geometry : DataModelObject, IFolderDataModelObject

Table 227: Members

Property ActiveBodies (p. 575) Gets the ActiveBodies.


Property AnalysisType (p. 575) Gets the AnalysisType.
Property AssignMaterialOnUpdate (p. 575) Gets or sets the
AssignMaterialOnUpdate.
Property AttachFileViaTempFile (p. 575) Gets or sets the
AttachFileViaTempFile.
Property AttributeKey (p. 576) Gets the AttributeKey.
Property Attributes (p. 576) Gets the Attributes.
Property Average (p. 576) Gets the Average.
Property Bodies (p. 576) Gets the Bodies.
Property CanChangeCADUnits (p. 576) Gets the CanChangeCADUnits.
Property Children (p. 576) Gets the list of children.
Property Comments (p. 577) Gets the list of associated
comments.
Property ComparePartsOnUpdate (p. 577) Gets the ComparePartsOnUpdate.
Property ComparePartsTolerance (p. 577) Gets the ComparePartsTolerance.
Property DataModelObjectCategory (p. 577) Gets the current DataModelObject's
category.
Property DecomposeDisjointGeometry (p. 577) Gets the
DecomposeDisjointGeometry.
Property DisplayStyle (p. 577) Gets or sets the DisplayStyle.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
572 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Property ElementControl (p. 578) Gets or sets the ElementControl.


Property Elements (p. 578) Gets the Elements.
Property EnclosureAndSymmetryProcessing (p. 578) Gets the
EnclosureAndSymmetryProcessing.
Property EndPlaneRotationAboutX (p. 578) Gets or sets the
EndPlaneRotationAboutX.
Property EndPlaneRotationAboutY (p. 578) Gets or sets the
EndPlaneRotationAboutY.
Property FiberLength (p. 578) Gets or sets the FiberLength.
Property Figures (p. 579) Gets the list of associated figures.
Property GeometryPreferencesReadOnly (p. 579) Gets the
GeometryPreferencesReadOnly.
Property Images (p. 579) Gets the list of associated images.
Property ImportCoordinateSystems (p. 579) Gets the ImportCoordinateSystems.
Property InternalObject (p. 579) Gets the internal object. For
advanced usage only.
Property LengthUnit (p. 579) Gets or sets the LengthUnit.
Property LengthX (p. 580) Gets the LengthX.
Property LengthY (p. 580) Gets the LengthY.
Property LengthZ (p. 580) Gets the LengthZ.
Property LineBodies (p. 580) Gets the LineBodies.
Property Mass (p. 580) Gets the Mass.
Property MaterialProperties (p. 580) Gets the MaterialProperties.
Property Maximum (p. 581) Gets the Maximum.
Property MeshMetric (p. 581) Gets the MeshMetric.
Property MeshVolume (p. 581) Gets the MeshVolume.
Property Minimum (p. 581) Gets the Minimum.
Property MixedImportResolution (p. 581) Gets the MixedImportResolution.
Property Model2DBehavior (p. 581) Gets or sets the Model2DBehavior.
Property NamedSelectionKey (p. 582) Gets the NamedSelectionKey.
Property NamedSelections (p. 582) Gets the NamedSelections.
Property Nodes (p. 582) Gets the Nodes.
Property ParameterKey (p. 582) Gets the ParameterKey.
Property Parameters (p. 582) Gets the Parameters.
Property ReaderModeSavesUpdatedFile (p. 582) Gets or sets the
ReaderModeSavesUpdatedFile.
Property ScaleFactorValue (p. 583) Gets or sets the ScaleFactorValue.
Property SheetSurfaceArea (p. 583) Gets the SheetSurfaceArea.
Property SmartCADUpdate (p. 583) Gets the SmartCADUpdate.
Property SolidBodies (p. 583) Gets the SolidBodies.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 573
Ansys.ACT.Automation.Mechanical Namespace

Property Source (p. 583) Gets the Source.


Property StandardDeviation (p. 583) Gets the StandardDeviation.
Property SurfaceArea (p. 584) Gets the SurfaceArea.
Property SurfaceBodies (p. 584) Gets the SurfaceBodies.
Property TemporaryDirectory (p. 584) Gets or sets the TemporaryDirectory.
Property Tolerance2D (p. 584) Gets or sets the Tolerance2D.
Property Type (p. 584) Gets the Type.
Property UseAssociativity (p. 584) Gets the UseAssociativity.
Property UseInstances (p. 585) Gets the UseInstances.
Property Volume (p. 585) Gets the Volume.
Property XCentroid (p. 585) Gets the XCentroid.
Property YCentroid (p. 585) Gets the YCentroid.
Property ZCentroid (p. 585) Gets the ZCentroid.
Method AddComment() (p. 585) Creates a new child Comment.
Method AddDistributedMass() (p. 586) Creates a new DistributedMass
Method AddElementOrientation() (p. 586) Creates a new ElementOrientation
Method AddFigure() (p. 586) Creates a new child Figure.
Method AddImage(string) (p. 586) Creates a new child Image. If a
filePath is provided, the image will
be loaded from that file, if not, the
image will be a screen capture of
the Geometry window.
Method AddImportedElementOrientationExternalData() (p. 586) Creates a new Imported Element
Orientation (External Data).
Method AddImportedThicknessExternalData() (p. 587) Creates a new Imported Thickness
(External Data).
Method AddLayeredSection() (p. 587) Creates a new child LayeredSection.
Method AddPointMass() (p. 587) Creates a new PointMass
Method AddSurfaceCoating() (p. 587) Creates a new SurfaceCoating
Method AddThermalPointMass() (p. 587) Creates a new ThermalPointMass
Method AddThickness() (p. 587) Creates a new child Thickness.
Method CenterOfMass(IList<IBaseGeoBody>, IList<PointMass>, Calculates the center of mass of the
IList<DistributedMass>) (p. 588) selected bodies and point masses.
Method ExportParts(string, IList<int>) (p. 588) Method to export parts. If the
second argument partIds is not
provided or is null, all Geometry
parts will be exported.
Method FreezeMeshOnAllParts() (p. 588) Run the FreezeMeshOnAllParts
action.
Method GetBody(IBaseGeoBody) (p. 589) Gets the Body associated with the
given IGeoBody

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
574 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by


IList<ChildrenType>) (p. 589) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 589) type.
Method GetPart(IBaseGeoPart) (p. 590) Gets the Part associated with the
given IGeoPart
Method InvertSuppressedBodySet() (p. 590) Invert all parts Suppressed property.
Method ResetBodyColors() (p. 590) Run the ResetBodyColors action.
Method UnfreezeMeshOnAllParts() (p. 590) Run the UnfreezeMeshOnAllParts
action.
Method UnsuppressAllBodies() (p. 591) Unsuppress all the bodies that were
suppressed.
Method UpdateGeometryFromSource() (p. 591) Run the
UpdateGeometryFromSource action.

ActiveBodies
Gets the ActiveBodies.

Declaration Syntax
public int ActiveBodies { get; }

AnalysisType
Gets the AnalysisType.

Declaration Syntax
public GeometryDimensionType AnalysisType { get; }

AssignMaterialOnUpdate
Gets or sets the AssignMaterialOnUpdate.

Declaration Syntax
public bool AssignMaterialOnUpdate { set;get; }

AttachFileViaTempFile
Gets or sets the AttachFileViaTempFile.

Declaration Syntax
public bool AttachFileViaTempFile { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 575
Ansys.ACT.Automation.Mechanical Namespace

AttributeKey
Gets the AttributeKey.

Declaration Syntax
public string AttributeKey { get; }

Attributes
Gets the Attributes.

Declaration Syntax
public bool Attributes { get; }

Average
Gets the Average.

Declaration Syntax
public double Average { get; }

Bodies
Gets the Bodies.

Declaration Syntax
public int Bodies { get; }

CanChangeCADUnits
Gets the CanChangeCADUnits.

Declaration Syntax
public bool CanChangeCADUnits { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
576 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ComparePartsOnUpdate
Gets the ComparePartsOnUpdate.

Declaration Syntax
public ComparePartsOnUpdateType ComparePartsOnUpdate { get; }

ComparePartsTolerance
Gets the ComparePartsTolerance.

Declaration Syntax
public ComparePartsToleranceType ComparePartsTolerance { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DecomposeDisjointGeometry
Gets the DecomposeDisjointGeometry.

Declaration Syntax
public bool DecomposeDisjointGeometry { get; }

DisplayStyle
Gets or sets the DisplayStyle.

Declaration Syntax
public PrototypeDisplayStyleType DisplayStyle { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 577
Ansys.ACT.Automation.Mechanical Namespace

ElementControl
Gets or sets the ElementControl.

Declaration Syntax
public ElementControl ElementControl { set;get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

EnclosureAndSymmetryProcessing
Gets the EnclosureAndSymmetryProcessing.

Declaration Syntax
public bool EnclosureAndSymmetryProcessing { get; }

EndPlaneRotationAboutX
Gets or sets the EndPlaneRotationAboutX.

Declaration Syntax
public Quantity EndPlaneRotationAboutX { set;get; }

EndPlaneRotationAboutY
Gets or sets the EndPlaneRotationAboutY.

Declaration Syntax
public Quantity EndPlaneRotationAboutY { set;get; }

FiberLength
Gets or sets the FiberLength.

Declaration Syntax
public Quantity FiberLength { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
578 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GeometryPreferencesReadOnly
Gets the GeometryPreferencesReadOnly.

Declaration Syntax
public bool GeometryPreferencesReadOnly { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImportCoordinateSystems
Gets the ImportCoordinateSystems.

Declaration Syntax
public bool ImportCoordinateSystems { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPrototypeGroupAuto InternalObject { get; }

LengthUnit
Gets or sets the LengthUnit.

Declaration Syntax
public WBUnitSystemType LengthUnit { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 579
Ansys.ACT.Automation.Mechanical Namespace

LengthX
Gets the LengthX.

Declaration Syntax
public Quantity LengthX { get; }

LengthY
Gets the LengthY.

Declaration Syntax
public Quantity LengthY { get; }

LengthZ
Gets the LengthZ.

Declaration Syntax
public Quantity LengthZ { get; }

LineBodies
Gets the LineBodies.

Declaration Syntax
public bool LineBodies { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

MaterialProperties
Gets the MaterialProperties.

Declaration Syntax
public bool MaterialProperties { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
580 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

MeshMetric
Gets the MeshMetric.

Declaration Syntax
public MeshMetricType MeshMetric { get; }

MeshVolume
Gets the MeshVolume.

Declaration Syntax
public Quantity MeshVolume { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public double Minimum { get; }

MixedImportResolution
Gets the MixedImportResolution.

Declaration Syntax
public SecondaryImportPrefType MixedImportResolution { get; }

Model2DBehavior
Gets or sets the Model2DBehavior.

Declaration Syntax
public Model2DBehavior Model2DBehavior { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 581
Ansys.ACT.Automation.Mechanical Namespace

NamedSelectionKey
Gets the NamedSelectionKey.

Declaration Syntax
public string NamedSelectionKey { get; }

NamedSelections
Gets the NamedSelections.

Declaration Syntax
public bool NamedSelections { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

ParameterKey
Gets the ParameterKey.

Declaration Syntax
public string ParameterKey { get; }

Parameters
Gets the Parameters.

Declaration Syntax
public ImportParameterType Parameters { get; }

ReaderModeSavesUpdatedFile
Gets or sets the ReaderModeSavesUpdatedFile.

Declaration Syntax
public bool ReaderModeSavesUpdatedFile { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
582 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Declaration Syntax
public double ScaleFactorValue { set;get; }

SheetSurfaceArea
Gets the SheetSurfaceArea.

Declaration Syntax
public Quantity SheetSurfaceArea { get; }

SmartCADUpdate
Gets the SmartCADUpdate.

Declaration Syntax
public bool SmartCADUpdate { get; }

SolidBodies
Gets the SolidBodies.

Declaration Syntax
public bool SolidBodies { get; }

Source
Gets the Source.

Declaration Syntax
public string Source { get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public double StandardDeviation { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 583
Ansys.ACT.Automation.Mechanical Namespace

SurfaceArea
Gets the SurfaceArea.

Declaration Syntax
public Quantity SurfaceArea { get; }

SurfaceBodies
Gets the SurfaceBodies.

Declaration Syntax
public bool SurfaceBodies { get; }

TemporaryDirectory
Gets or sets the TemporaryDirectory.

Declaration Syntax
public string TemporaryDirectory { set;get; }

Tolerance2D
Gets or sets the Tolerance2D.

Declaration Syntax
public double Tolerance2D { set;get; }

Type
Gets the Type.

Declaration Syntax
public string Type { get; }

UseAssociativity
Gets the UseAssociativity.

Declaration Syntax
public bool UseAssociativity { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
584 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

UseInstances
Gets the UseInstances.

Declaration Syntax
public bool UseInstances { get; }

Volume
Gets the Volume.

Declaration Syntax
public Quantity Volume { get; }

XCentroid
Gets the XCentroid.

Declaration Syntax
public Quantity XCentroid { get; }

YCentroid
Gets the YCentroid.

Declaration Syntax
public Quantity YCentroid { get; }

ZCentroid
Gets the ZCentroid.

Declaration Syntax
public Quantity ZCentroid { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 585
Ansys.ACT.Automation.Mechanical Namespace

AddDistributedMass()
Creates a new DistributedMass

Declaration Syntax
public virtual DistributedMass AddDistributedMass()

AddElementOrientation()
Creates a new ElementOrientation

Declaration Syntax
public virtual ElementOrientation AddElementOrientation()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImportedElementOrientationExternalData()
Creates a new Imported Element Orientation (External Data).

Declaration Syntax
public virtual ImportedElementOrientationGroup AddImportedElementOrientationExternalData()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
586 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

AddImportedThicknessExternalData()
Creates a new Imported Thickness (External Data).

Declaration Syntax
public virtual ImportedThicknessGroup AddImportedThicknessExternalData()

AddLayeredSection()
Creates a new child LayeredSection.

Declaration Syntax
public virtual LayeredSection AddLayeredSection()

AddPointMass()
Creates a new PointMass

Declaration Syntax
public virtual PointMass AddPointMass()

AddSurfaceCoating()
Creates a new SurfaceCoating

Declaration Syntax
public virtual SurfaceCoating AddSurfaceCoating()

AddThermalPointMass()
Creates a new ThermalPointMass

Declaration Syntax
public virtual ThermalPointMass AddThermalPointMass()

AddThickness()
Creates a new child Thickness.

Declaration Syntax
public virtual Thickness AddThickness()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 587
Ansys.ACT.Automation.Mechanical Namespace

CenterOfMass(IList<IBaseGeoBody>, IList<PointMass>, IList<Distributed-


Mass>)
Calculates the center of mass of the selected bodies and point masses.

Declaration Syntax
public virtual Quantity[] CenterOfMass(IList<IBaseGeoBody> geoBodies, IList<PointMass> pointMasses,
IList<DistributedMass> distributedMasses)

Parameters
geoBodies(IList<IBaseGeoBody>)

No details are provided for this entry.

pointMasses(IList<PointMass>)

No details are provided for this entry.

distributedMasses(IList<DistributedMass>)

No details are provided for this entry.

ExportParts(string, IList<int>)
Method to export parts. If the second argument partIds is not provided or is null, all Geometry parts
will be exported.

Declaration Syntax
public virtual void ExportParts(string filePath, IList<int> partIds)

Parameters
filePath(string)

No details are provided for this entry.

partIds(IList<int>)

No details are provided for this entry.

FreezeMeshOnAllParts()
Run the FreezeMeshOnAllParts action.

Declaration Syntax
public virtual void FreezeMeshOnAllParts()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
588 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry

GetBody(IBaseGeoBody)
Gets the Body associated with the given IGeoBody

Declaration Syntax
public virtual Body GetBody(IBaseGeoBody geoBody)

Parameters
geoBody(IBaseGeoBody)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 589
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetPart(IBaseGeoPart)
Gets the Part associated with the given IGeoPart

Declaration Syntax
public virtual Part GetPart(IBaseGeoPart geoPart)

Parameters
geoPart(IBaseGeoPart)

No details are provided for this entry.

InvertSuppressedBodySet()
Invert all parts Suppressed property.

Declaration Syntax
public virtual void InvertSuppressedBodySet()

ResetBodyColors()
Run the ResetBodyColors action.

Declaration Syntax
public virtual void ResetBodyColors()

UnfreezeMeshOnAllParts()
Run the UnfreezeMeshOnAllParts action.

Declaration Syntax
public virtual void UnfreezeMeshOnAllParts()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
590 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryFileContainer

UnsuppressAllBodies()
Unsuppress all the bodies that were suppressed.

Declaration Syntax
public virtual void UnsuppressAllBodies()

UpdateGeometryFromSource()
Run the UpdateGeometryFromSource action.

Declaration Syntax
public virtual void UpdateGeometryFromSource()

GeometryFileContainer
Defines a GeometryFileContainer.

Declaration Syntax
public class GeometryFileContainer : ImportedDataModelObject, IFolderDataModelObject

Table 228: Members

Property Children (p. 592) Gets the list of children.


Property Comments (p. 592) Gets the list of associated comments.
Property DataModelObjectCategory (p. 592) Gets the current DataModelObject's category.
Property Figures (p. 592) Gets the list of associated figures.
Property Images (p. 592) Gets the list of associated images.
Property InternalObject (p. 592) Gets the internal object. For advanced usage only.
Property LengthUnits (p. 593) Gets or sets the LengthUnits.
Property ShowAlways (p. 593) Gets or sets the ShowAlways.
Property Statistics (p. 593) Gets the Statistics.
Property Suppressed (p. 593) Gets or sets the Suppressed.
Method AddComment() (p. 593) Creates a new child Comment.
Method AddFigure() (p. 593) Creates a new child Figure.
Method AddImage(string) (p. 594) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 594) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 594)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 591
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 595)
Method ImportSTL() (p. 595) Run the ImportSTL action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
592 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryFileContainer

Declaration Syntax
public IDSGeometryFileContainerAuto InternalObject { get; }

LengthUnits
Gets or sets the LengthUnits.

Declaration Syntax
public WBUnitSystemType LengthUnits { set;get; }

ShowAlways
Gets or sets the ShowAlways.

Declaration Syntax
public bool ShowAlways { set;get; }

Statistics
Gets the Statistics.

Declaration Syntax
public int Statistics { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 593
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
594 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImport

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ImportSTL()
Run the ImportSTL action.

Declaration Syntax
public virtual void ImportSTL()

GeometryImport
Defines a GeometryImport.

Declaration Syntax
public class GeometryImport : DataModelObject, IRemovableDataModelObjectPreAction, IRemov-
ableDataModelObject, IRemovableDataModelObjectPostAction, IFolderDataModelObject

Table 229: Members

Property Children (p. 596) Gets the list of children.


Property Comments (p. 596) Gets the list of associated comments.
Property DataModelObjectCategory (p. 597) Gets the current DataModelObject's category.
Property Figures (p. 597) Gets the list of associated figures.
Property Images (p. 597) Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 595
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 597) Gets the internal object. For advanced usage only.
Property Parts (p. 597) List of parts created by the most recent import
operation.
Method AddComment() (p. 597) Creates a new child Comment.
Method AddFigure() (p. 598) Creates a new child Figure.
Method AddImage(string) (p. 598) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 598)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 598)
Method GetFormat() (p. 599) Gets the format of the geometry file/data for the
most recent import.
Method GetGeometryURI() (p. 599) Gets the Geometry URI for the most recent import.
The Universal Resource Identifier, which on disk
would be "file://..."
Method GetPreferences() (p. 599) Gets the preferences for most recent import
operations with the geometry file/data.
Method Import(string, Format, Import/reload geometry from the CAD file using
GeometryImportPreferences) (p. 599) the provided preferences. *** If no preference
argument is provided, i.e., null is used (also the
default argument), then default values from
Mechanical preferences will be used (Mechanical:
File -> Options: Import; this will need to be
implemented). Previously used preferences are
always purged during an import operation. *** The
parts will be read into the Geometry.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
596 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImport

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeometryImportAuto InternalObject { get; }

Parts
List of parts created by the most recent import operation.

Declaration Syntax
public IList<object> Parts { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 597
Ansys.ACT.Automation.Mechanical Namespace

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
598 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImport

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetFormat()
Gets the format of the geometry file/data for the most recent import.

Declaration Syntax
public virtual Format GetFormat()

GetGeometryURI()
Gets the Geometry URI for the most recent import. The Universal Resource Identifier, which on disk
would be "file://..."

Declaration Syntax
public virtual string GetGeometryURI()

GetPreferences()
Gets the preferences for most recent import operations with the geometry file/data.

Declaration Syntax
public virtual GeometryImportPreferences GetPreferences()

Import(string, Format, GeometryImportPreferences)


Import/reload geometry from the CAD file using the provided preferences. *** If no preference argu-
ment is provided, i.e., null is used (also the default argument), then default values from Mechanical
preferences will be used (Mechanical: File -> Options: Import; this will need to be implemented).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 599
Ansys.ACT.Automation.Mechanical Namespace

Previously used preferences are always purged during an import operation. *** The parts will be read
into the Geometry.

Declaration Syntax
public virtual void Import(string geometryURI, Format format, GeometryImportPreferences preferences)

Parameters
geometryURI(string)

The geometry data source URI.

format(Format)

The import format to use.

preferences(GeometryImportPreferences)

The import preferences to use.

GeometryImportGroup
Defines a GeometryImportGroup.

Declaration Syntax
public class GeometryImportGroup : DataModelObject, IReadOnlyList<GeometryImport>, IReadOnlyCol-
lection<GeometryImport>, IEnumerable<GeometryImport>, IEnumerable, IFolderDataModelObject

Table 230: Members

Property Children (p. 601) Gets the list of children.


Property Comments (p. 601) Gets the list of associated comments.
Property Count (p. 601) Get the number of child

GeometryImport instances.
Property DataModelObjectCategory (p. 601) Gets the current DataModelObject's category.
Property Figures (p. 601) Gets the list of associated figures.
Property Images (p. 602) Gets the list of associated images.
Property InternalObject (p. 602) Gets the internal object. For advanced usage only.
Property Item (p. 602) Get a child

GeometryImport instance.
Method AddComment() (p. 602) Creates a new child Comment.
Method AddFigure() (p. 602) Creates a new child Figure.
Method AddGeometryImport() (p. 603) Create the object for working with an imported
part.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
600 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportGroup

Method AddImage(string) (p. 603) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 603)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 603)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Count
Get the number of child

GeometryImport instances.

Declaration Syntax
public int Count { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 601
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeometryImportGroupAuto InternalObject { get; }

Item(int)
Get a child

GeometryImport instance.

Declaration Syntax
public GeometryImport Item { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
602 of ANSYS, Inc. and its subsidiaries and affiliates.
GeometryImportGroup

AddGeometryImport()
Create the object for working with an imported part.

Declaration Syntax
public virtual GeometryImport AddGeometryImport()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 603
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GlobalVonMisesStressConstraint
Defines a GlobalVonMisesStressConstraint.

Defines a GlobalVonMisesStressConstraint.

Declaration Syntax
public class GlobalVonMisesStressConstraint : ResponseConstraint

Table 231: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 605)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 605) Gets the internal object. For advanced usage only.
Property Maximum (p. 605) Gets or sets the Maximum.
Property ScopingMethod (p. 605) Gets or sets the ScopingMethod.
Property StressType (p. 605) Gets or sets the StressType.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
604 of ANSYS, Inc. and its subsidiaries and affiliates.
HatCrossSection

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Maximum
Gets or sets the Maximum.

Declaration Syntax
public Field Maximum { get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

StressType
Gets or sets the StressType.

Declaration Syntax
public TopoConstraintStressType StressType { set;get; }

HatCrossSection
Defines a HatCrossSection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 605
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class HatCrossSection : CrossSection

Table 232: Members

Property Area (p. 606) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 606)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 607) Gets the internal object. For advanced usage
only.
Property IYY (p. 607) Gets the IYY.
Property IZZ (p. 607) Gets the IZZ.
Property Thick1 (p. 607) Gets or sets the Thick1.
Property Thick2 (p. 607) Gets or sets the Thick2.
Property Thick3 (p. 607) Gets or sets the Thick3.
Property Thick4 (p. 608) Gets or sets the Thick4.
Property Thick5 (p. 608) Gets or sets the Thick5.
Property Width1 (p. 608) Gets or sets the Width1.
Property Width2 (p. 608) Gets or sets the Width2.
Property Width3 (p. 608) Gets or sets the Width3.
Property Width4 (p. 608) Gets or sets the Width4.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
606 of ANSYS, Inc. and its subsidiaries and affiliates.
HatCrossSection

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Declaration Syntax
public Quantity Thick2 { set;get; }

Thick3
Gets or sets the Thick3.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 607
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity Thick3 { set;get; }

Thick4
Gets or sets the Thick4.

Declaration Syntax
public Quantity Thick4 { set;get; }

Thick5
Gets or sets the Thick5.

Declaration Syntax
public Quantity Thick5 { set;get; }

Width1
Gets or sets the Width1.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

Width3
Gets or sets the Width3.

Declaration Syntax
public Quantity Width3 { set;get; }

Width4
Gets or sets the Width4.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
608 of ANSYS, Inc. and its subsidiaries and affiliates.
HollowRectangularCrossSection

Declaration Syntax
public Quantity Width4 { set;get; }

HollowRectangularCrossSection
Defines a HollowRectangularCrossSection.

Declaration Syntax
public class HollowRectangularCrossSection : CrossSection

Table 233: Members

Property Area (p. 609) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 610)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 610) Gets the internal object. For advanced usage
only.
Property IYY (p. 610) Gets the IYY.
Property IZZ (p. 610) Gets the IZZ.
Property Thick1 (p. 610) Gets or sets the Thick1.
Property Thick2 (p. 610) Gets or sets the Thick2.
Property Thick3 (p. 611) Gets or sets the Thick3.
Property Thick4 (p. 611) Gets or sets the Thick4.
Property Width1 (p. 611) Gets or sets the Width1.
Property Width2 (p. 611) Gets or sets the Width2.

Area
Gets the Area.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 609
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
610 of ANSYS, Inc. and its subsidiaries and affiliates.
HousingConstraint

Declaration Syntax
public Quantity Thick2 { set;get; }

Thick3
Gets or sets the Thick3.

Declaration Syntax
public Quantity Thick3 { set;get; }

Thick4
Gets or sets the Thick4.

Declaration Syntax
public Quantity Thick4 { set;get; }

Width1
Gets or sets the Width1.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

HousingConstraint
Defines a HousingConstraint.

Defines a HousingConstraint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 611
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class HousingConstraint : ManufacturingConstraint

Table 234: Members

Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property DataModelObjectCategory (p. 612)Gets the current DataModelObject's
category.
Property HousingLocation (p. 612) Gets or sets the HousingLocation.
Property HousingScopingMethod (p. 612) Gets or sets the HousingScopingMethod.
Property InternalObject (p. 613) Gets the internal object. For advanced usage
only.
Property Location (p. 613) Gets or sets the Location.
Property ScopingMethod (p. 613) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

HousingLocation
Gets or sets the HousingLocation.

Declaration Syntax
public ISelectionInfo HousingLocation { set;get; }

HousingScopingMethod
Gets or sets the HousingScopingMethod.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
612 of ANSYS, Inc. and its subsidiaries and affiliates.
ICrossSection

Declaration Syntax
public GeometryDefineByType HousingScopingMethod { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

ICrossSection
Defines a ICrossSection.

Declaration Syntax
public class ICrossSection : CrossSection

Table 235: Members

Property Area (p. 614) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 614)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 613
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 614) Gets the internal object. For advanced usage
only.
Property IYY (p. 614) Gets the IYY.
Property IZZ (p. 615) Gets the IZZ.
Property Thick1 (p. 615) Gets or sets the Thick1.
Property Thick2 (p. 615) Gets or sets the Thick2.
Property Thick3 (p. 615) Gets or sets the Thick3.
Property Width1 (p. 615) Gets or sets the Width1.
Property Width2 (p. 615) Gets or sets the Width2.
Property Width3 (p. 616) Gets or sets the Width3.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
614 of ANSYS, Inc. and its subsidiaries and affiliates.
ICrossSection

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Declaration Syntax
public Quantity Thick2 { set;get; }

Thick3
Gets or sets the Thick3.

Declaration Syntax
public Quantity Thick3 { set;get; }

Width1
Gets or sets the Width1.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 615
Ansys.ACT.Automation.Mechanical Namespace

Width3
Gets or sets the Width3.

Declaration Syntax
public Quantity Width3 { set;get; }

Image
Defines a Image.

Declaration Syntax
public class Image : DataModelObject, IFolderDataModelObject

Table 236: Members

Property Children (p. 616) Gets the list of children.


Property Comments (p. 616) Gets the list of associated comments.
Property DataModelObjectCategory (p. 617) Gets the current DataModelObject's category.
Property Images (p. 617) Gets the list of associated images.
Property InternalObject (p. 617) Gets the internal object. For advanced usage only.
Method AddComment() (p. 617) Creates a new child Comment.
Method AddImage(string) (p. 617) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 618) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 618)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 618)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
616 of ANSYS, Inc. and its subsidiaries and affiliates.
Image

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSAdvancedPostOutputAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 617
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
618 of ANSYS, Inc. and its subsidiaries and affiliates.
ImagePlane

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ImagePlane
Defines a ImagePlane.

Declaration Syntax
public class ImagePlane : DataModelObject, IFolderDataModelObject

Table 237: Members

Property Children (p. 620) Gets the list of children.


Property Comments (p. 620) Gets the list of associated comments.
Property CoordinateSystem (p. 620) Gets or sets the coordinate system object used for
defining the plane’s location and orientation. This
property is restricted to cartesian coordinate
systems.
Property CoordinateSystemVisible (p. 620) Gets or sets whether the annotation for the image’s
coordinate system is rendered.
Property DataModelObjectCategory (p. 621) Gets the current DataModelObject's category.
Property FlipHorizontally (p. 621) Gets or sets whether the rendered image on the
plane should be flipped horizontally.
Property FlipVertically (p. 621) Gets or sets whether the rendered image on the
plane should be flipped vertically.
Property Height (p. 621) Gets or sets the physical height of the image plane.
Property ImageFilePath (p. 621) Gets the file path for the rendered image.
Property Images (p. 621) Gets the list of associated images.
Property InternalObject (p. 622) Gets the internal object. For advanced usage only.
Property PixelHeight (p. 622) Gets the pixel height of the plane's image.
Property PixelWidth (p. 622) Gets the pixel width of the plane's image.
Property ShowAlways (p. 622) Gets or sets whether the image plane will be shown
independent of the active object in the tree.
Property Translucency (p. 622) Gets or sets the translucency of the plane, as a
percentage ranging from 0 to 100.
Property Width (p. 622) Gets or sets the physical width of the image plane.
Method AddComment() (p. 623) Creates a new child Comment.
Method Delete() (p. 623) Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 619
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.


IList<ChildrenType>) (p. 623)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 623)
Method Import(string) (p. 624) Sets the image which is rendered to this plane,
specified by filePath. Upon success, ImageFilePath
will return filePath. Upon failure, ImageFilePath will
remain unchanged. Supported file formats include
PNG, JPEG, BMP, and GIF. If this is the first time an
image has been set to this image plane and if
Width and Height were never modified, the image
plane will be automatically sized based on the
model’s bounding box, respecting the image’s
aspect ratio.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the coordinate system object used for defining the plane’s location and orientation. This
property is restricted to cartesian coordinate systems.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CoordinateSystemVisible
Gets or sets whether the annotation for the image’s coordinate system is rendered.

Declaration Syntax
public bool CoordinateSystemVisible { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
620 of ANSYS, Inc. and its subsidiaries and affiliates.
ImagePlane

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FlipHorizontally
Gets or sets whether the rendered image on the plane should be flipped horizontally.

Declaration Syntax
public bool FlipHorizontally { set;get; }

FlipVertically
Gets or sets whether the rendered image on the plane should be flipped vertically.

Declaration Syntax
public bool FlipVertically { set;get; }

Height
Gets or sets the physical height of the image plane.

Declaration Syntax
public Quantity Height { set;get; }

ImageFilePath
Gets the file path for the rendered image.

Declaration Syntax
public string ImageFilePath { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 621
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSAdvancedPostOutputAuto InternalObject { get; }

PixelHeight
Gets the pixel height of the plane's image.

Declaration Syntax
public int PixelHeight { get; }

PixelWidth
Gets the pixel width of the plane's image.

Declaration Syntax
public int PixelWidth { get; }

ShowAlways
Gets or sets whether the image plane will be shown independent of the active object in the tree.

Declaration Syntax
public bool ShowAlways { set;get; }

Translucency
Gets or sets the translucency of the plane, as a percentage ranging from 0 to 100.

Declaration Syntax
public int Translucency { set;get; }

Width
Gets or sets the physical width of the image plane.

Declaration Syntax
public Quantity Width { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
622 of ANSYS, Inc. and its subsidiaries and affiliates.
ImagePlane

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 623
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Import(string)
Sets the image which is rendered to this plane, specified by filePath. Upon success, ImageFilePath
will return filePath. Upon failure, ImageFilePath will remain unchanged. Supported file formats include
PNG, JPEG, BMP, and GIF. If this is the first time an image has been set to this image plane and if
Width and Height were never modified, the image plane will be automatically sized based on the
model’s bounding box, respecting the image’s aspect ratio.

Declaration Syntax
public virtual void Import(string filePath)

Parameters
filePath(string)

No details are provided for this entry.

ImportedBoltPretensions
Defines a ImportedBoltPretensions.

Declaration Syntax
public class ImportedBoltPretensions : ExternalModelDataColl

Table 238: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
624 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedCondensedPart

Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 625)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 625) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedCondensedPart
Defines a ImportedCondensedPart.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 625
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ImportedCondensedPart : CondensedPartBase

Table 239: Members

Property ActualNodeOffset (p. 629) Gets the


ActualNodeOffset.
Property Children (p. 374) Gets the list of
children.

(Inherited from
CondensedPartBase (p. 373).)
Property Comments (p. 374) Gets the list of
associated comments.

(Inherited from
CondensedPartBase (p. 373).)
Property CondensedPartFileName (p. 629) Gets or sets the
CondensedPartFileName.
Property CondensedPartUnitSystem (p. 629) Gets or sets the
CondensedPartUnitSystem.
Property CoordinateSystem (p. 629) Gets or sets the
CoordinateSystem.
Property DataModelObjectCategory (p. 630) Gets the current
DataModelObject's
category.
Property ExpansionStatus (p. 630) "ExpansionStatus"
property defines if
results can be
expanded of the
imported condensed
part or not.
Property Figures (p. 375) Gets the list of
associated figures.

(Inherited from
CondensedPartBase (p. 373).)
Property FutureIntent (p. 630) "FutureIntent"
property defines the
type of solver
supported to perform
a use pass with the
imported condensed
part.
Property GeometrySelection (p. 375) Gets or sets the
GeometrySelection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
626 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedCondensedPart

(Inherited from
CondensedPartBase (p. 373).)
Property Images (p. 375) Gets the list of
associated images.

(Inherited from
CondensedPartBase (p. 373).)
Property ImportFileFormat (p. 630) Gets or sets the
ImportFileFormat.
Property ImportStatus (p. 630) Gets the
ImportStatus.
Property InternalObject (p. 630) Gets the internal
object. For advanced
usage only.
Property NodeOffset (p. 631) Gets or sets the
NodeOffset.
Property NumberInterfaceEntries (p. 375) Gets the
NumberInterfaceEntries.

(Inherited from
CondensedPartBase (p. 373).)
Property NumberMasterNodes (p. 375) Gets the
NumberMasterNodes.

(Inherited from
CondensedPartBase (p. 373).)
Property Physics (p. 376) Gets the Physics.

(Inherited from
CondensedPartBase (p. 373).)
Property ReferenceTemperature (p. 376) Gets or sets the
ReferenceTemperature.

(Inherited from
CondensedPartBase (p. 373).)
Property SolutionName (p. 376) Gets or sets the
SolutionName.

(Inherited from
CondensedPartBase (p. 373).)
Property SolutionNameMode (p. 376) Gets or sets the
SolutionNameMode.

(Inherited from
CondensedPartBase (p. 373).)
Property SolverFilesDirectory (p. 376) Gets the
SolverFilesDirectory.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 627
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
CondensedPartBase (p. 373).)
Property SolverUnits (p. 376) Gets or sets the
SolverUnits.

(Inherited from
CondensedPartBase (p. 373).)
Property SolverUnitSystem (p. 377) Gets or sets the
SolverUnitSystem.

(Inherited from
CondensedPartBase (p. 373).)
Property Suppressed (p. 377) Gets or sets the
Suppressed.

(Inherited from
CondensedPartBase (p. 373).)
Property TemperatureUnits (p. 377) Gets the
TemperatureUnits.

(Inherited from
CondensedPartBase (p. 373).)
Method CreateJointFromNodeIds(IEnumerable<int>) (p. 631) Create a Joint with
the provided node
IDs.
Method CreateJoints(IEnumerable<int>) (p. 631) Creates Joints
corresponding to the
provided interface ID
Numbers.
Method CreateNodalNamedSelectionFromNodeIds(IEnumerable<int>) (p. 631) Create a Nodal
Named Selection with
the provided node
IDs.
Method CreateNodalNamedSelections(IEnumerable<int>) (p. 632) Creates Nodal Named
Selections
corresponding to the
provided interface ID
Numbers.
Method CreateRemotePointFromNodeIds(IEnumerable<int>) (p. 632) Create a Remote
Point with the
provided node IDs.
Method CreateRemotePoints(IEnumerable<int>) (p. 632) Creates Remote
Points corresponding
to the provided
interface ID Numbers.
Method GetOriginalNodeCoordinates() (p. 633) Get all the Node
Locations of the

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
628 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedCondensedPart

Original Interfaces
Data table.
Method GetTransformedNodeCoordinates() (p. 633) Get all the Node
Locations of the
Transformed
Interfaces Data table.
Method ImportCondensedPart() (p. 633) Run the Import
Condensed Part
action.
Method ReadInterfaceData() (p. 633) Run the Read
Interface Data action.
Method UpdateNodeLocation(int, Quantity, Quantity, Quantity, Quantity, Update Node
Quantity, Quantity) (p. 633) Location of Original
Interfaces Data view
table.

ActualNodeOffset
Gets the ActualNodeOffset.

Declaration Syntax
public uint ActualNodeOffset { get; }

CondensedPartFileName
Gets or sets the CondensedPartFileName.

Declaration Syntax
public string CondensedPartFileName { set;get; }

CondensedPartUnitSystem
Gets or sets the CondensedPartUnitSystem.

Declaration Syntax
public WBUnitSystemType CondensedPartUnitSystem { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 629
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ExpansionStatus
"ExpansionStatus" property defines if results can be expanded of the imported condensed part or
not.

Declaration Syntax
public ExpansionStatus ExpansionStatus { get; }

FutureIntent
"FutureIntent" property defines the type of solver supported to perform a use pass with the imported
condensed part.

Declaration Syntax
public FutureIntentType FutureIntent { get; }

ImportFileFormat
Gets or sets the ImportFileFormat.

Declaration Syntax
public CondensedPartFileFormat ImportFileFormat { set;get; }

ImportStatus
Gets the ImportStatus.

Declaration Syntax
public ImportedCondensedPartStatus ImportStatus { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
630 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedCondensedPart

Declaration Syntax
public IDSCondensedPartAuto InternalObject { get; }

NodeOffset
Gets or sets the NodeOffset.

Declaration Syntax
public uint NodeOffset { set;get; }

CreateJointFromNodeIds(IEnumerable<int>)
Create a Joint with the provided node IDs.

Declaration Syntax
public virtual DataModelObject CreateJointFromNodeIds(IEnumerable<int> selectedNodeIds)

Parameters
selectedNodeIds(IEnumerable<int>)

List of node IDs to be scoped on the Joint.

CreateJoints(IEnumerable<int>)
Creates Joints corresponding to the provided interface ID Numbers.

Declaration Syntax
public virtual IEnumerable<DataModelObject> CreateJoints(IEnumerable<int> selectedInterfaceIDNum-
bers)

Parameters
selectedInterfaceIDNumbers(IEnumerable<int>)

List of interface ID Numbers on which Joints to be created.

CreateNodalNamedSelectionFromNodeIds(IEnumerable<int>)
Create a Nodal Named Selection with the provided node IDs.

Declaration Syntax
public virtual DataModelObject CreateNodalNamedSelectionFromNodeIds(IEnumerable<int> selected-
NodeIds)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 631
Ansys.ACT.Automation.Mechanical Namespace

Parameters
selectedNodeIds(IEnumerable<int>)

List of node IDs to be scoped on the Named Selection.

CreateNodalNamedSelections(IEnumerable<int>)
Creates Nodal Named Selections corresponding to the provided interface ID Numbers.

Declaration Syntax
public virtual IEnumerable<DataModelObject> CreateNodalNamedSelections(IEnumerable<int> selec-
tedInterfaceIDNumbers)

Parameters
selectedInterfaceIDNumbers(IEnumerable<int>)

List of interface ID Numbers on which Nodal Named Selections to be created.

CreateRemotePointFromNodeIds(IEnumerable<int>)
Create a Remote Point with the provided node IDs.

Declaration Syntax
public virtual DataModelObject CreateRemotePointFromNodeIds(IEnumerable<int> selectedNodeIds)

Parameters
selectedNodeIds(IEnumerable<int>)

List of node IDs to be scoped on the Remote Point.

CreateRemotePoints(IEnumerable<int>)
Creates Remote Points corresponding to the provided interface ID Numbers.

Declaration Syntax
public virtual IEnumerable<DataModelObject> CreateRemotePoints(IEnumerable<int> selectedInter-
faceIDNumbers)

Parameters
selectedInterfaceIDNumbers(IEnumerable<int>)

List of interface ID Numbers on which Remote Points to be created.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
632 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedCondensedPart

GetOriginalNodeCoordinates()
Get all the Node Locations of the Original Interfaces Data table.

Declaration Syntax
public virtual IEnumerable<KeyValuePair<int, IEnumerable<Quantity>>> GetOriginalNodeCoordinates()

GetTransformedNodeCoordinates()
Get all the Node Locations of the Transformed Interfaces Data table.

Declaration Syntax
public virtual IEnumerable<KeyValuePair<int, IEnumerable<Quantity>>> GetTransformedNodeCoordin-
ates()

ImportCondensedPart()
Run the Import Condensed Part action.

Declaration Syntax
public virtual void ImportCondensedPart()

ReadInterfaceData()
Run the Read Interface Data action.

Declaration Syntax
public virtual void ReadInterfaceData()

UpdateNodeLocation(int, Quantity, Quantity, Quantity, Quantity, Quantity,


Quantity)
Update Node Location of Original Interfaces Data view table.

Declaration Syntax
public virtual void UpdateNodeLocation(int iNodeID, Quantity locX, Quantity locY, Quantity locZ,
Quantity rotX, Quantity rotY, Quantity rotZ)

Parameters
iNodeID(int)

Node ID to be update.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 633
Ansys.ACT.Automation.Mechanical Namespace

locX(Quantity)

Location X

locY(Quantity)

Location Y

locZ(Quantity)

Location Z

rotX(Quantity)

Rotation X

rotY(Quantity)

Rotation Y

rotZ(Quantity)

Rotation Z

ImportedConstraintEquations
Defines a ImportedConstraintEquations.

Declaration Syntax
public class ImportedConstraintEquations : ExternalModelDataColl

Table 240: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 635)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
634 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedContacts

Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 635) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedContacts
Defines a ImportedContacts.

Declaration Syntax
public class ImportedContacts : ExternalModelDataColl

Table 241: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 635
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 636)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 636) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedCoordinateSystems
Defines a ImportedCoordinateSystems.

Declaration Syntax
public class ImportedCoordinateSystems : ExternalModelDataColl

Table 242: Members

Property Children (p. 514) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
636 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedElementOrientations

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 637)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 637) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedElementOrientations
Defines a ImportedElementOrientations.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 637
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ImportedElementOrientations : ExternalModelDataColl

Table 243: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 638)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 638) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
638 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedFlexibleRemoteConnectors

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedFlexibleRemoteConnectors
Defines a ImportedFlexibleRemoteConnectors.

Declaration Syntax
public class ImportedFlexibleRemoteConnectors : ExternalModelDataColl

Table 244: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 639)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 640) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 639
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedLayeredSection
Defines a ImportedLayeredSection.

Declaration Syntax
public class ImportedLayeredSection : ExternalEnhancedModel

Table 245: Members

Property Children (p. 510) Gets the list of children.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Comments (p. 510) Gets the list of associated comments.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property DataModelObjectCategory (p. 641) Gets the current DataModelObject's
category.
Property Figures (p. 510) Gets the list of associated figures.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Images (p. 510) Gets the list of associated images.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property InternalObject (p. 641) Gets the internal object. For advanced usage
only.
Property LayerToDisplay (p. 511) Gets or sets the LayerToDisplay.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property MaximumNumberOfLayers (p. 511) Gets the MaximumNumberOfLayers.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
640 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedNodalOrientations

(Inherited from
ExternalEnhancedModel (p. 509).)
Property NonlinearEffects (p. 511) Gets or sets the NonlinearEffects.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Suppressed (p. 511) Gets or sets the Suppressed.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property ThermalStrainEffects (p. 511) Gets or sets the ThermalStrainEffects.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Type (p. 511) Gets the Type.

(Inherited from
ExternalEnhancedModel (p. 509).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalEnhancedModelAuto InternalObject { get; }

ImportedNodalOrientations
Defines a ImportedNodalOrientations.

Declaration Syntax
public class ImportedNodalOrientations : ExternalModelDataColl

Table 246: Members

Property Children (p. 514) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 641
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 642)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 642) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedObject
Defines a row object in Imported Objects.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
642 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedObject

Declaration Syntax
public class ImportedObject

Table 247: Members

Property Active (p. 643) This property sets the object to active or inactive
status
Property InternalObject (p. 643) Gets the internal object. For advanced usage only.
Method GetPropertyNames() (p. 643) This method gives the complete list of property
names that are supported.
Method GetPropertyValueAsString(string) (p. 643) Data in string format that is present on the
columns
Method SetPropertyValue(string, object) (p. 644) Set the data for a give property name

Active
This property sets the object to active or inactive status

Declaration Syntax
public bool Active { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSWorksheetRowDataAuto InternalObject { get; }

GetPropertyNames()
This method gives the complete list of property names that are supported.

Declaration Syntax
public IEnumerable<string> GetPropertyNames()

GetPropertyValueAsString(string)
Data in string format that is present on the columns

Declaration Syntax
public string GetPropertyValueAsString(string name)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 643
Ansys.ACT.Automation.Mechanical Namespace

Parameters
name(string)

No details are provided for this entry.

SetPropertyValue(string, object)
Set the data for a give property name

Declaration Syntax
public void SetPropertyValue(string name, object value)

Parameters
name(string)

No details are provided for this entry.

value(object)

No details are provided for this entry.

ImportedPlies
Defines a ImportedPlies.

Declaration Syntax
public class ImportedPlies : ExternalEnhancedModel

Table 248: Members

Property Children (p. 510) Gets the list of children.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Comments (p. 510) Gets the list of associated comments.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property DataModelObjectCategory (p. 645) Gets the current DataModelObject's
category.
Property Figures (p. 510) Gets the list of associated figures.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Images (p. 510) Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
644 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedPliesCollection

(Inherited from
ExternalEnhancedModel (p. 509).)
Property InternalObject (p. 645) Gets the internal object. For advanced usage
only.
Property LayerToDisplay (p. 511) Gets or sets the LayerToDisplay.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property MaximumNumberOfLayers (p. 511) Gets the MaximumNumberOfLayers.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property NonlinearEffects (p. 511) Gets or sets the NonlinearEffects.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Suppressed (p. 511) Gets or sets the Suppressed.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property ThermalStrainEffects (p. 511) Gets or sets the ThermalStrainEffects.

(Inherited from
ExternalEnhancedModel (p. 509).)
Property Type (p. 511) Gets the Type.

(Inherited from
ExternalEnhancedModel (p. 509).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalEnhancedModelAuto InternalObject { get; }

ImportedPliesCollection
Defines a ImportedPliesCollection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 645
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ImportedPliesCollection : ImportedDataModelObject, IFolderDataModelObject

Table 249: Members

Property Children (p. 646) Gets the list of children.


Property Comments (p. 646) Gets the list of associated comments.
Property DataModelObjectCategory (p. 646) Gets the current DataModelObject's category.
Property Figures (p. 647) Gets the list of associated figures.
Property Images (p. 647) Gets the list of associated images.
Property InternalObject (p. 647) Gets the internal object. For advanced usage only.
Method AddComment() (p. 647) Creates a new child Comment.
Method AddFigure() (p. 647) Creates a new child Figure.
Method AddImage(string) (p. 647) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 648)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 648)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
646 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedPliesCollection

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSImportedPliesCollectionAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 647
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
648 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedPointMasses

ImportedPointMasses
Defines a ImportedPointMasses.

Declaration Syntax
public class ImportedPointMasses : ExternalModelDataColl

Table 250: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 649)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 650) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 649
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedPremeshedBoltPretensions
Defines a ImportedPremeshedBoltPretensions.

Declaration Syntax
public class ImportedPremeshedBoltPretensions : ExternalModelDataColl

Table 251: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 651)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 651) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
650 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedRigidRemoteConnectors

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedRigidRemoteConnectors
Defines a ImportedRigidRemoteConnectors.

Declaration Syntax
public class ImportedRigidRemoteConnectors : ExternalModelDataColl

Table 252: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 652)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 651
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 652) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedShellThicknesses
Defines a ImportedShellThicknesses.

Declaration Syntax
public class ImportedShellThicknesses : ExternalModelDataColl

Table 253: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 653)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
652 of ANSYS, Inc. and its subsidiaries and affiliates.
ImportedSpringConnectors

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 653) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedSpringConnectors
Defines a ImportedSpringConnectors.

Declaration Syntax
public class ImportedSpringConnectors : ExternalModelDataColl

Table 254: Members

Property Children (p. 514) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 653
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 654)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 654) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedStresses
Defines a ImportedStresses.

Declaration Syntax
public class ImportedStresses : ExternalModelDataColl

Table 255: Members

Property Children (p. 514) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
654 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

(Inherited from
ExternalModelDataColl (p. 513).)
Property Comments (p. 514) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Count (p. 514) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 513).)
Property DataModelObjectCategory (p. 655)Gets the current DataModelObject's
category.
Property Figures (p. 515) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 513).)
Property Images (p. 515) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 513).)
Property InternalObject (p. 655) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 515) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 513).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

InitialCondition
Defines a InitialCondition.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 655
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class InitialCondition : DataModelObject, IFolderDataModelObject

Table 256: Members

Property Children (p. 658) Gets the list of children.


Property Comments (p. 658) Gets the list of associated comments.
Property ContactStatus (p. 658) Gets or sets the ContactStatus.
Property CoordinateSystem (p. 658) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 658) Gets the current DataModelObject's
category.
Property DefineBy (p. 658) Gets or sets the DefineBy.
Property Direction (p. 659) Gets or sets the Direction.
Property DropDirection (p. 659) Gets or sets the DropDirection.
Property DropHeight (p. 659) Gets or sets the DropHeight.
Property DropTestDefineBy (p. 659) Gets or sets the DropTestDefineBy.
Property ExplicitPreStressTime (p. 659) Gets or sets the ExplicitPreStressTime.
Property Figures (p. 659) Gets the list of associated figures.
Property Images (p. 660) Gets the list of associated images.
Property ImpactVelocity (p. 660) Gets or sets the ImpactVelocity.
Property InitialEnvironment (p. 660) Gets or sets the InitialEnvironment.
Property InitialTemperature (p. 660) Gets or sets the InitialTemperature.
Property InitialTemperatureValue (p. 660) Gets or sets the
InitialTemperatureValue.
Property InputType (p. 660) Gets or sets the InputType.
Property InternalObject (p. 661) Gets the internal object. For advanced
usage only.
Property LoadControl (p. 661) Gets or sets the LoadControl.
Property Location (p. 661) Gets or sets the Location.
Property ModalEnvironmentHarmonicIC ***OBSOLETE*** Gets or sets the
Use 'ModalICEnvironment' property ModalEnvironmentHarmonicIC.
instead. (p. 661)
Property ModalEnvironmentPSDIC ***OBSOLETE*** Use Gets or sets the
'ModalICEnvironment' property instead. (p. 661) ModalEnvironmentPSDIC.
Property ModalEnvironmentRSIC ***OBSOLETE*** Use Gets or sets the
'ModalICEnvironment' property instead. (p. 662) ModalEnvironmentRSIC.
Property ModalEnvironmentTransientMSUPIC Gets or sets the
***OBSOLETE*** Use 'ModalICEnvironment' ModalEnvironmentTransientMSUPIC.
property instead. (p. 662)
Property ModalICEnvironment (p. 662) Gets or sets the ModalICEnvironment.
Property Mode (p. 662) Gets or sets the Mode.
Property NewtonRaphsonOption (p. 662) Gets the NewtonRaphsonOption.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
656 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

Property PressureInitialization (p. 662) Gets or sets the PressureInitialization.


Property PreStressDefineBy (p. 663) Gets or sets the PreStressDefineBy.
Property PreStressEnvironmentHarmonicIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentHarmonicIC.
instead. (p. 663)
Property PreStressEnvironmentHarmonicMSUPModal (p. 663) Gets the
PreStressEnvironmentHarmonicMSUPModal.
Property PreStressEnvironmentModalIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentModalIC.
instead. (p. 663)
Property PreStressEnvironmentTransientIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentTransientIC.
instead. (p. 663)
Property PreStressEnvironmentTransientMSUPModal (p. 664) Gets the
PreStressEnvironmentTransientMSUPModal.
Property PreStressICEnvironment (p. 664) Gets or sets the
PreStressICEnvironment.
Property PreStressLoadStep (p. 664) Gets or sets the PreStressLoadStep.
Property PreStressTime (p. 664) Gets or sets the PreStressTime.
Property ReferenceTemperature (p. 664) Gets or sets the
ReferenceTemperature.
Property ReportedLoadStep (p. 664) Gets the ReportedLoadStep.
Property ReportedSubStep (p. 665) Gets the ReportedSubStep.
Property ReportedTime (p. 665) Gets the ReportedTime.
Property Suppressed (p. 665) Gets or sets the Suppressed.
Property Time (p. 665) Gets or sets the Time.
Property TimeStepFactor (p. 665) Gets or sets the TimeStepFactor.
Property TotalMagnitude (p. 665) Gets or sets the Magnitude.
Property XComponent (p. 666) Gets or sets the XComponent.
Property YComponent (p. 666) Gets or sets the YComponent.
Property ZComponent (p. 666) Gets or sets the ZComponent.
Method AddCommandSnippet() (p. 666) Creates a new child
CommandSnippet.
Method AddComment() (p. 666) Creates a new child Comment.
Method AddFigure() (p. 666) Creates a new child Figure.
Method AddImage(string) (p. 667) Creates a new child Image. If a
filePath is provided, the image will be
loaded from that file, if not, the image
will be a screen capture of the
Geometry window.
Method Delete() (p. 667) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 667) type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 657
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by


IList<IDataModelObject>) (p. 667) type.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ContactStatus
Gets or sets the ContactStatus.

Declaration Syntax
public PreStressContactStatus ContactStatus { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineBy
Gets or sets the DefineBy.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
658 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

Declaration Syntax
public LoadDefineBy DefineBy { set;get; }

Direction
Gets or sets the Direction.

Declaration Syntax
public Vector3D Direction { set;get; }

DropDirection
Gets or sets the DropDirection.

Declaration Syntax
public DropDirection DropDirection { set;get; }

DropHeight
Gets or sets the DropHeight.

Declaration Syntax
public Quantity DropHeight { set;get; }

DropTestDefineBy
Gets or sets the DropTestDefineBy.

Declaration Syntax
public DropTestDefineBy DropTestDefineBy { set;get; }

ExplicitPreStressTime
Gets or sets the ExplicitPreStressTime.

Declaration Syntax
public Quantity ExplicitPreStressTime { set;get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 659
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImpactVelocity
Gets or sets the ImpactVelocity.

Declaration Syntax
public Quantity ImpactVelocity { set;get; }

InitialEnvironment
Gets or sets the InitialEnvironment.

Declaration Syntax
public Analysis InitialEnvironment { set;get; }

InitialTemperature
Gets or sets the InitialTemperature.

Declaration Syntax
public InitialTemperatureType InitialTemperature { set;get; }

InitialTemperatureValue
Gets or sets the InitialTemperatureValue.

Declaration Syntax
public Quantity InitialTemperatureValue { set;get; }

InputType
Gets or sets the InputType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
660 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

Declaration Syntax
public InitialConditionsType InputType { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSInitialConditionsAuto InternalObject { get; }

LoadControl
Gets or sets the LoadControl.

Declaration Syntax
public PreStressLoadControl LoadControl { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ModalEnvironmentHarmonicIC ***OBSOLETE*** Use 'ModalICEnvironment'


property instead.
Gets or sets the ModalEnvironmentHarmonicIC.

Declaration Syntax
public Analysis ModalEnvironmentHarmonicIC { set;get; }

ModalEnvironmentPSDIC ***OBSOLETE*** Use 'ModalICEnvironment'


property instead.
Gets or sets the ModalEnvironmentPSDIC.

Declaration Syntax
public Analysis ModalEnvironmentPSDIC { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 661
Ansys.ACT.Automation.Mechanical Namespace

ModalEnvironmentRSIC ***OBSOLETE*** Use 'ModalICEnvironment' property


instead.
Gets or sets the ModalEnvironmentRSIC.

Declaration Syntax
public Analysis ModalEnvironmentRSIC { set;get; }

ModalEnvironmentTransientMSUPIC ***OBSOLETE*** Use 'ModalICEnviron-


ment' property instead.
Gets or sets the ModalEnvironmentTransientMSUPIC.

Declaration Syntax
public Analysis ModalEnvironmentTransientMSUPIC { set;get; }

ModalICEnvironment
Gets or sets the ModalICEnvironment.

Declaration Syntax
public Analysis ModalICEnvironment { set;get; }

Mode
Gets or sets the Mode.

Declaration Syntax
public PreStressMode Mode { set;get; }

NewtonRaphsonOption
Gets the NewtonRaphsonOption.

Declaration Syntax
public NewtonRaphsonType NewtonRaphsonOption { get; }

PressureInitialization
Gets or sets the PressureInitialization.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
662 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

Declaration Syntax
public PressureInitializationType PressureInitialization { set;get; }

PreStressDefineBy
Gets or sets the PreStressDefineBy.

Declaration Syntax
public PreStressStateType PreStressDefineBy { set;get; }

PreStressEnvironmentHarmonicIC ***OBSOLETE*** Use 'PreStressICEnvir-


onment' property instead.
Gets or sets the PreStressEnvironmentHarmonicIC.

Declaration Syntax
public Analysis PreStressEnvironmentHarmonicIC { set;get; }

PreStressEnvironmentHarmonicMSUPModal
Gets the PreStressEnvironmentHarmonicMSUPModal.

Declaration Syntax
public Analysis PreStressEnvironmentHarmonicMSUPModal { get; }

PreStressEnvironmentModalIC ***OBSOLETE*** Use 'PreStressICEnviron-


ment' property instead.
Gets or sets the PreStressEnvironmentModalIC.

Declaration Syntax
public Analysis PreStressEnvironmentModalIC { set;get; }

PreStressEnvironmentTransientIC ***OBSOLETE*** Use 'PreStressICEnviron-


ment' property instead.
Gets or sets the PreStressEnvironmentTransientIC.

Declaration Syntax
public Analysis PreStressEnvironmentTransientIC { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 663
Ansys.ACT.Automation.Mechanical Namespace

PreStressEnvironmentTransientMSUPModal
Gets the PreStressEnvironmentTransientMSUPModal.

Declaration Syntax
public Analysis PreStressEnvironmentTransientMSUPModal { get; }

PreStressICEnvironment
Gets or sets the PreStressICEnvironment.

Declaration Syntax
public Analysis PreStressICEnvironment { set;get; }

PreStressLoadStep
Gets or sets the PreStressLoadStep.

Declaration Syntax
public double PreStressLoadStep { set;get; }

PreStressTime
Gets or sets the PreStressTime.

Declaration Syntax
public Quantity PreStressTime { set;get; }

ReferenceTemperature
Gets or sets the ReferenceTemperature.

Declaration Syntax
public Quantity ReferenceTemperature { set;get; }

ReportedLoadStep
Gets the ReportedLoadStep.

Declaration Syntax
public int ReportedLoadStep { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
664 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

ReportedSubStep
Gets the ReportedSubStep.

Declaration Syntax
public int ReportedSubStep { get; }

ReportedTime
Gets the ReportedTime.

Declaration Syntax
public double ReportedTime { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Time
Gets or sets the Time.

Declaration Syntax
public Quantity Time { set;get; }

TimeStepFactor
Gets or sets the TimeStepFactor.

Declaration Syntax
public double TimeStepFactor { set;get; }

TotalMagnitude
Gets or sets the Magnitude.

Declaration Syntax
public Quantity TotalMagnitude { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 665
Ansys.ACT.Automation.Mechanical Namespace

XComponent
Gets or sets the XComponent.

Declaration Syntax
public Quantity XComponent { set;get; }

YComponent
Gets or sets the YComponent.

Declaration Syntax
public Quantity YComponent { set;get; }

ZComponent
Gets or sets the ZComponent.

Declaration Syntax
public Quantity ZComponent { set;get; }

AddCommandSnippet()
Creates a new child CommandSnippet.

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
666 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialCondition

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 667
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

InitialConditions
Defines a InitialConditions.

Declaration Syntax
public class InitialConditions : DataModelObject, IFolderDataModelObject

Table 257: Members

Property Children (p. 669) Gets the list of children.


Property Comments (p. 669) Gets the list of associated comments.
Property DataModelObjectCategory (p. 669) Gets the current DataModelObject's category.
Property Figures (p. 669) Gets the list of associated figures.
Property Images (p. 669) Gets the list of associated images.
Property InternalObject (p. 669) Gets the internal object. For advanced usage only.
Method AddComment() (p. 670) Creates a new child Comment.
Method AddFigure() (p. 670) Creates a new child Figure.
Method AddImage(string) (p. 670) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 670)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 671)
Method InsertAngularVelocity() (p. 671) Creates a new Angular Velocity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
668 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialConditions

Method InsertDropHeight() (p. 671) Creates a new Drop Height


Method InsertVelocity() (p. 671) Creates a new Velocity

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 669
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSInitialConditionGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
670 of ANSYS, Inc. and its subsidiaries and affiliates.
InitialConditions

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

InsertAngularVelocity()
Creates a new Angular Velocity

Declaration Syntax
public virtual InitialCondition InsertAngularVelocity()

InsertDropHeight()
Creates a new Drop Height

Declaration Syntax
public virtual InitialCondition InsertDropHeight()

InsertVelocity()
Creates a new Velocity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 671
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual InitialCondition InsertVelocity()

InterfaceDelamination
Defines a InterfaceDelamination.

Declaration Syntax
public class InterfaceDelamination : GenericDelamination

Table 258: Members

Property AutomaticTimeStepping (p. 673) Gets or sets the AutomaticTimeStepping.


Property Children (p. 565) Gets the list of children.

(Inherited from GenericDelamination (p. 564).)


Property Comments (p. 565) Gets the list of associated comments.

(Inherited from GenericDelamination (p. 564).)


Property CriticalRate (p. 673) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 673) Gets the current DataModelObject's
category.
Property DistanceTolerance (p. 673) Gets or sets the DistanceTolerance.
Property FailureCriteriaOption (p. 673) Gets or sets the FailureCriteriaOption.
Property Figures (p. 565) Gets the list of associated figures.

(Inherited from GenericDelamination (p. 564).)


Property GenerationMethod (p. 673) Gets or sets the GenerationMethod.
Property Images (p. 565) Gets the list of associated images.

(Inherited from GenericDelamination (p. 564).)


Property InitialCrack (p. 674) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 674) Gets or sets the InitialTimeStep.
Property InternalObject (p. 674) Gets the internal object. For advanced usage
only.
Property MatchControl (p. 674) Gets or sets the MatchControl.
Property Material (p. 674) Gets or sets the Material.
Property MaximumTimeStep (p. 674) Gets or sets the MaximumTimeStep.
Property Method (p. 675) Gets or sets the Method.
Property MinimumTimeStep (p. 675) Gets or sets the MinimumTimeStep.
Property SourceLocation (p. 675) Gets or sets the SourceLocation.
Property Suppressed (p. 675) Gets or sets the Suppressed.
Property TargetLocation (p. 675) Gets or sets the TargetLocation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
672 of ANSYS, Inc. and its subsidiaries and affiliates.
InterfaceDelamination

Property ToleranceType (p. 675) Gets or sets the ToleranceType.


Property Type (p. 676) Gets the Type.

AutomaticTimeStepping
Gets or sets the AutomaticTimeStepping.

Declaration Syntax
public AutomaticOrManual AutomaticTimeStepping { set;get; }

CriticalRate
Gets or sets the CriticalRate.

Declaration Syntax
public Quantity CriticalRate { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DistanceTolerance
Gets or sets the DistanceTolerance.

Declaration Syntax
public Quantity DistanceTolerance { set;get; }

FailureCriteriaOption
Gets or sets the FailureCriteriaOption.

Declaration Syntax
public DelaminationFailureCriteriaOption FailureCriteriaOption { set;get; }

GenerationMethod
Gets or sets the GenerationMethod.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 673
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DelaminationGenerationMethod GenerationMethod { set;get; }

InitialCrack
Gets or sets the InitialCrack.

Declaration Syntax
public GenericCrack InitialCrack { set;get; }

InitialTimeStep
Gets or sets the InitialTimeStep.

Declaration Syntax
public Quantity InitialTimeStep { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

MatchControl
Gets or sets the MatchControl.

Declaration Syntax
public MatchControl MatchControl { set;get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaximumTimeStep
Gets or sets the MaximumTimeStep.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
674 of ANSYS, Inc. and its subsidiaries and affiliates.
InterfaceDelamination

Declaration Syntax
public Quantity MaximumTimeStep { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public DelaminationMethod Method { set;get; }

MinimumTimeStep
Gets or sets the MinimumTimeStep.

Declaration Syntax
public Quantity MinimumTimeStep { set;get; }

SourceLocation
Gets or sets the SourceLocation.

Declaration Syntax
public ISelectionInfo SourceLocation { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TargetLocation
Gets or sets the TargetLocation.

Declaration Syntax
public ISelectionInfo TargetLocation { set;get; }

ToleranceType
Gets or sets the ToleranceType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 675
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ToleranceType ToleranceType { set;get; }

Type
Gets the Type.

Declaration Syntax
public DelaminationType Type { get; }

JointBushingWorksheet
The worksheet of stiffness and damping coefficients for a bushing type joint.

Declaration Syntax
public class JointBushingWorksheet : Worksheet

Table 259: Members

Method GetBushingDampingPerThetaUnitX(int) (p. 677) Gets the Coefficient for the damping per
ThetaUnitX at the indicated row index.
Method GetBushingDampingPerThetaUnitY(int) (p. 677) Gets the Coefficient for the damping per
ThetaUnitY at the indicated row index.
Method GetBushingDampingPerThetaUnitZ(int) (p. 678) Gets the Coefficient for the damping per
ThetaUnitZ at the indicated row index.
Method GetBushingDampingPerUnitX(int) (p. 678) Gets the Coefficient for the damping per
UnitX at the indicated row index.
Method GetBushingDampingPerUnitY(int) (p. 678) Gets the Coefficient for the damping per
UnitY at the indicated row index.
Method GetBushingDampingPerUnitZ(int) (p. 679) Gets the Coefficient for the damping per
UnitZ at the indicated row index.
Method GetBushingStiffnessPerThetaUnitX(int) (p. 679) Gets the Coefficient for the stiffness per
ThetaUnitX at the indicated row index.
Method GetBushingStiffnessPerThetaUnitY(int) (p. 679) Gets the Coefficient for the stiffness per
ThetaUnitY at the indicated row index.
Method GetBushingStiffnessPerThetaUnitZ(int) (p. 679) Gets the Coefficient for the stiffness per
ThetaUnitZ at the indicated row index.
Method GetBushingStiffnessPerUnitX(int) (p. 680) Gets the Coefficient for the stiffness per
UnitX at the indicated row index.
Method GetBushingStiffnessPerUnitY(int) (p. 680) Gets the Coefficient for the stiffness per
UnitY at the indicated row index.
Method GetBushingStiffnessPerUnitZ(int) (p. 680) Gets the Coefficient for the stiffness per
UnitZ at the indicated row index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
676 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

Method SetBushingDampingPerThetaUnitX(int, Sets the Coefficient for the damping per


double) (p. 681) ThetaUnitX at the indicated row index.
Method SetBushingDampingPerThetaUnitY(int, Sets the Coefficient for the damping per
double) (p. 681) ThetaUnitY at the indicated row index.
Method SetBushingDampingPerThetaUnitZ(int, Sets the Coefficient for the damping per
double) (p. 681) ThetaUnitZ at the indicated row index.
Method SetBushingDampingPerUnitX(int, Sets the Coefficient for the damping per
double) (p. 682) UnitX at the indicated row index.
Method SetBushingDampingPerUnitY(int, Sets the Coefficient for the damping per
double) (p. 682) UnitY at the indicated row index.
Method SetBushingDampingPerUnitZ(int, Sets the Coefficient for the damping per
double) (p. 682) UnitZ at the indicated row index.
Method SetBushingStiffnessPerThetaUnitX(int, Sets the Coefficient for the stiffness per
double) (p. 683) ThetaUnitX at the indicated row index.
Method SetBushingStiffnessPerThetaUnitY(int, Sets the Coefficient for the stiffness per
double) (p. 683) ThetaUnitY at the indicated row index.
Method SetBushingStiffnessPerThetaUnitZ(int, Sets the Coefficient for the stiffness per
double) (p. 683) ThetaUnitZ at the indicated row index.
Method SetBushingStiffnessPerUnitX(int, Sets the Coefficient for the stiffness per UnitX
double) (p. 684) at the indicated row index.
Method SetBushingStiffnessPerUnitY(int, Sets the Coefficient for the stiffness per UnitY
double) (p. 684) at the indicated row index.
Method SetBushingStiffnessPerUnitZ(int, Sets the Coefficient for the stiffness per UnitZ
double) (p. 685) at the indicated row index.

GetBushingDampingPerThetaUnitX(int)
Gets the Coefficient for the damping per ThetaUnitX at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerThetaUnitX(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 3 and less than 6.

GetBushingDampingPerThetaUnitY(int)
Gets the Coefficient for the damping per ThetaUnitY at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerThetaUnitY(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 677
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 4 and less than 6.

GetBushingDampingPerThetaUnitZ(int)
Gets the Coefficient for the damping per ThetaUnitZ at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerThetaUnitZ(int index)

Parameters
index(int)

Worksheet row index. Must be equal to 5.

GetBushingDampingPerUnitX(int)
Gets the Coefficient for the damping per UnitX at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerUnitX(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 0 and less than 6.

GetBushingDampingPerUnitY(int)
Gets the Coefficient for the damping per UnitY at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerUnitY(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 1 and less than 6.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
678 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

GetBushingDampingPerUnitZ(int)
Gets the Coefficient for the damping per UnitZ at the indicated row index.

Declaration Syntax
public double GetBushingDampingPerUnitZ(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 2 and less than 6.

GetBushingStiffnessPerThetaUnitX(int)
Gets the Coefficient for the stiffness per ThetaUnitX at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerThetaUnitX(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 3 and less than 6.

GetBushingStiffnessPerThetaUnitY(int)
Gets the Coefficient for the stiffness per ThetaUnitY at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerThetaUnitY(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 4 and less than 6.

GetBushingStiffnessPerThetaUnitZ(int)
Gets the Coefficient for the stiffness per ThetaUnitZ at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerThetaUnitZ(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 679
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

Worksheet row index. Must be equal to 5.

GetBushingStiffnessPerUnitX(int)
Gets the Coefficient for the stiffness per UnitX at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerUnitX(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 0 and less than 6.

GetBushingStiffnessPerUnitY(int)
Gets the Coefficient for the stiffness per UnitY at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerUnitY(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 1 and less than 6.

GetBushingStiffnessPerUnitZ(int)
Gets the Coefficient for the stiffness per UnitZ at the indicated row index.

Declaration Syntax
public double GetBushingStiffnessPerUnitZ(int index)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 2 and less than 6.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
680 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

SetBushingDampingPerThetaUnitX(int, double)
Sets the Coefficient for the damping per ThetaUnitX at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerThetaUnitX(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 3 and less than 6.

newVal(double)

New value for damping per ThetaUnitX.

SetBushingDampingPerThetaUnitY(int, double)
Sets the Coefficient for the damping per ThetaUnitY at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerThetaUnitY(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 4 and less than 6.

newVal(double)

New value for damping per ThetaUnitY.

SetBushingDampingPerThetaUnitZ(int, double)
Sets the Coefficient for the damping per ThetaUnitZ at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerThetaUnitZ(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be equal to 5.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 681
Ansys.ACT.Automation.Mechanical Namespace

newVal(double)

New value for damping per ThetaUnitZ.

SetBushingDampingPerUnitX(int, double)
Sets the Coefficient for the damping per UnitX at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerUnitX(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 0 and less than 6.

newVal(double)

New value for damping per UnitX.

SetBushingDampingPerUnitY(int, double)
Sets the Coefficient for the damping per UnitY at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerUnitY(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 1 and less than 6.

newVal(double)

New value for damping per UnitY.

SetBushingDampingPerUnitZ(int, double)
Sets the Coefficient for the damping per UnitZ at the indicated row index.

Declaration Syntax
public double SetBushingDampingPerUnitZ(int index, double newVal)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
682 of ANSYS, Inc. and its subsidiaries and affiliates.
JointBushingWorksheet

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 2 and less than 6.

newVal(double)

New value for damping per UnitZ.

SetBushingStiffnessPerThetaUnitX(int, double)
Sets the Coefficient for the stiffness per ThetaUnitX at the indicated row index.

Declaration Syntax
public double SetBushingStiffnessPerThetaUnitX(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 3 and less than 6.

newVal(double)

New value for stiffness per ThetaUnitX.

SetBushingStiffnessPerThetaUnitY(int, double)
Sets the Coefficient for the stiffness per ThetaUnitY at the indicated row index.

Declaration Syntax
public double SetBushingStiffnessPerThetaUnitY(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 4 and less than 6.

newVal(double)

New value for stiffness per ThetaUnitY.

SetBushingStiffnessPerThetaUnitZ(int, double)
Sets the Coefficient for the stiffness per ThetaUnitZ at the indicated row index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 683
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double SetBushingStiffnessPerThetaUnitZ(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be equal to 5.

newVal(double)

New value for stiffness per ThetaUnitZ.

SetBushingStiffnessPerUnitX(int, double)
Sets the Coefficient for the stiffness per UnitX at the indicated row index.

Declaration Syntax
public double SetBushingStiffnessPerUnitX(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 0 and less than 6.

newVal(double)

New value for stiffness per UnitX.

SetBushingStiffnessPerUnitY(int, double)
Sets the Coefficient for the stiffness per UnitY at the indicated row index.

Declaration Syntax
public double SetBushingStiffnessPerUnitY(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 1 and less than 6.

newVal(double)

New value for stiffness per UnitY.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
684 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSection

SetBushingStiffnessPerUnitZ(int, double)
Sets the Coefficient for the stiffness per UnitZ at the indicated row index.

Declaration Syntax
public double SetBushingStiffnessPerUnitZ(int index, double newVal)

Parameters
index(int)

Worksheet row index. Must be greater than or equal to 2 and less than 6.

newVal(double)

New value for stiffness per UnitZ.

LayeredSection
Defines a LayeredSection.

Declaration Syntax
public class LayeredSection : DataModelObject, IFolderDataModelObject

Table 260: Members

Property Children (p. 686) Gets the list of children.


Property Comments (p. 686) Gets the list of associated comments.
Property CoordinateSystem (p. 686) Gets or sets the CoordinateSystem. Accepts/Returns
None for Body Coordinate System
Property DataModelObjectCategory (p. 686) Gets the current DataModelObject's category.
Property Figures (p. 687) Gets the list of associated figures.
Property Images (p. 687) Gets the list of associated images.
Property InternalObject (p. 687) Gets the internal object. For advanced usage only.
Property LayeredSectionMembraneOffset (p. 687) Gets or sets the LayeredSectionMembraneOffset.
Property Layers (p. 687) Returns the Layers worksheet associated with
LayeredSection
Property LayerToDisplay (p. 687) Gets or sets the LayerToDisplay.
Property Location (p. 688) Gets or sets the Location.
Property NonlinearEffects (p. 688) Gets or sets the NonlinearEffects.
Property OffsetType (p. 688) Gets or sets the OffsetType.
Property Suppressed (p. 688) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 688) Gets or sets the ThermalStrainEffects.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 685
Ansys.ACT.Automation.Mechanical Namespace

Property TotalMass (p. 688) Gets the TotalMass.


Property TotalThickness (p. 689) Gets the TotalThickness.
Method AddComment() (p. 689) Creates a new child Comment.
Method AddFigure() (p. 689) Creates a new child Figure.
Method AddImage(string) (p. 689) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 689) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 690)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 690)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem. Accepts/Returns None for Body Coordinate System

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
686 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSection

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSThicknessAuto InternalObject { get; }

LayeredSectionMembraneOffset
Gets or sets the LayeredSectionMembraneOffset.

Declaration Syntax
public Quantity LayeredSectionMembraneOffset { set;get; }

Layers
Returns the Layers worksheet associated with LayeredSection

Declaration Syntax
public IWorksheet Layers { get; }

LayerToDisplay
Gets or sets the LayerToDisplay.

Declaration Syntax
public int LayerToDisplay { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 687
Ansys.ACT.Automation.Mechanical Namespace

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NonlinearEffects
Gets or sets the NonlinearEffects.

Declaration Syntax
public bool NonlinearEffects { set;get; }

OffsetType
Gets or sets the OffsetType.

Declaration Syntax
public ShellOffsetType OffsetType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ThermalStrainEffects
Gets or sets the ThermalStrainEffects.

Declaration Syntax
public bool ThermalStrainEffects { set;get; }

TotalMass
Gets the TotalMass.

Declaration Syntax
public Quantity TotalMass { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
688 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSection

TotalThickness
Gets the TotalThickness.

Declaration Syntax
public Quantity TotalThickness { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 689
Ansys.ACT.Automation.Mechanical Namespace

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

LayeredSectionWorksheet
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
690 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSectionWorksheet

Declaration Syntax
public class LayeredSectionWorksheet : Worksheet

Table 261: Members

Property RowCount (p. 691) Gets the number of entries (rows) in the worksheet.
Method AddThicknessLayer(string, Add a row to the LayeredSectionWorksheet New layers
double, double) (p. 692) are added as the top most layer in the Z direction.
LayeredSectionWorksheet indices are zero based and
ordered in the Z direction.
Method DeleteRow(int) (p. 692) Delete a row from the LayeredSectionWorksheet
LayeredSectionWorksheet indices are zero based and
ordered in the Z direction.
Method GetAngle(int) (p. 692) Gets the angle for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.
Method GetMaterial(int) (p. 693) Gets the material for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.
Method GetThickness(int) (p. 693) Gets the thickness for the LayeredSection at the row
index specifiied. LayeredSectionWorksheet indices are
zero based and ordered in the Z direction.
Method InsertThicknessLayerAbove(string, Insert a new layer to the LayeredSectionWorksheet The
double, double, int) (p. 693) new layer will be inserted above the layer indicated by
the given index. LayeredSectionWorksheet indices are
zero based and ordered in the Z direction.
Method InsertThicknessLayerBelow(string, Insert a new layer to the LayeredSectionWorksheet The
double, double, int) (p. 694) new layer will be inserted below the layer indicated by
the given index. LayeredSectionWorksheet indices are
zero based and ordered in the Z direction.
Method SetAngle(int, double) (p. 694) Set the angle for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.
Method SetMaterial(int, string) (p. 695) Set the material for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.
Method SetThickness(int, double) (p. 695) Set the thickness for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.

RowCount
Gets the number of entries (rows) in the worksheet.

Declaration Syntax
public int RowCount { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 691
Ansys.ACT.Automation.Mechanical Namespace

AddThicknessLayer(string, double, double)


Add a row to the LayeredSectionWorksheet New layers are added as the top most layer in the Z dir-
ection. LayeredSectionWorksheet indices are zero based and ordered in the Z direction.

Declaration Syntax
public virtual int AddThicknessLayer(string materialname, double thickness, double angle)

Parameters
materialname(string)

The name of the material to be used in the new layer.

thickness(double)

The thickness to be used in the new layer

angle(double)

The angle to be used in the new layer

DeleteRow(int)
Delete a row from the LayeredSectionWorksheet LayeredSectionWorksheet indices are zero based
and ordered in the Z direction.

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)

Worksheet row index

GetAngle(int)
Gets the angle for the LayeredSection at the row index specifiied. LayeredSectionWorksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual double GetAngle(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
692 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSectionWorksheet

Parameters
index(int)

Worksheet row index

GetMaterial(int)
Gets the material for the LayeredSection at the row index specifiied. LayeredSectionWorksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual string GetMaterial(int index)

Parameters
index(int)

Worksheet row index

GetThickness(int)
Gets the thickness for the LayeredSection at the row index specifiied. LayeredSectionWorksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual double GetThickness(int index)

Parameters
index(int)

Worksheet row index

InsertThicknessLayerAbove(string, double, double, int)


Insert a new layer to the LayeredSectionWorksheet The new layer will be inserted above the layer
indicated by the given index. LayeredSectionWorksheet indices are zero based and ordered in the Z
direction.

Declaration Syntax
public int InsertThicknessLayerAbove(string materialname, double thickness, double angle, int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 693
Ansys.ACT.Automation.Mechanical Namespace

Parameters
materialname(string)

The name of the material to be used in the new layer.

thickness(double)

The thickness to be used in the new layer

angle(double)

The angle to be used in the new layer

index(int)

Worksheet row index

InsertThicknessLayerBelow(string, double, double, int)


Insert a new layer to the LayeredSectionWorksheet The new layer will be inserted below the layer
indicated by the given index. LayeredSectionWorksheet indices are zero based and ordered in the Z
direction.

Declaration Syntax
public int InsertThicknessLayerBelow(string materialname, double thickness, double angle, int index)

Parameters
materialname(string)

The name of the material to be used in the new layer.

thickness(double)

The thickness to be used in the new layer

angle(double)

The angle to be used in the new layer

index(int)

Worksheet row index

SetAngle(int, double)
Set the angle for the LayeredSection at the row index specifiied. LayeredSectionWorksheet indices
are zero based and ordered in the Z direction.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
694 of ANSYS, Inc. and its subsidiaries and affiliates.
LayeredSectionWorksheet

Declaration Syntax
public virtual void SetAngle(int index, double angle)

Parameters
index(int)

Worksheet row index

angle(double)

New angle value

SetMaterial(int, string)
Set the material for the LayeredSection at the row index specifiied. LayeredSectionWorksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual void SetMaterial(int index, string materialname)

Parameters
index(int)

Worksheet row index

materialname(string)

New material value

SetThickness(int, double)
Set the thickness for the LayeredSection at the row index specifiied. LayeredSectionWorksheet indices
are zero based and ordered in the Z direction.

Declaration Syntax
public virtual void SetThickness(int index, double thickness)

Parameters
index(int)

Worksheet row index

thickness(double)

New thickness value

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 695
Ansys.ACT.Automation.Mechanical Namespace

LCrossSection
Defines a LCrossSection.

Declaration Syntax
public class LCrossSection : CrossSection

Table 262: Members

Property Area (p. 696) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 696)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 697) Gets the internal object. For advanced usage
only.
Property IYY (p. 697) Gets the IYY.
Property IZZ (p. 697) Gets the IZZ.
Property Thick1 (p. 697) Gets or sets the Thick1.
Property Thick2 (p. 697) Gets or sets the Thick2.
Property Width1 (p. 697) Gets or sets the Width1.
Property Width2 (p. 698) Gets or sets the Width2.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
696 of ANSYS, Inc. and its subsidiaries and affiliates.
LCrossSection

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Declaration Syntax
public Quantity Thick2 { set;get; }

Width1
Gets or sets the Width1.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 697
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

LineChart2D
Defines a LineChart2D.

Declaration Syntax
public class LineChart2D : DataModelObject, ISupportChartOptions, IFolderDataModelObject

Table 263: Members

Property Children (p. 698) Gets the list of children.


Property DataModelObjectCategory (p. 698) Gets the current DataModelObject's
category.
Property InternalObject (p. 699) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 699) Gets or sets the Suppressed.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 699)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 699)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
698 of ANSYS, Inc. and its subsidiaries and affiliates.
LineChart2D

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSBasicResultChartAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 699
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

LoadHelper
No details are provided for this entry.

Declaration Syntax
public static class LoadHelper

Table 264: Members

Method SwitchAmbientTemperatureToTabular(Convection) (p. 700) No details are provided for this


entry.
Method SwitchFilmCoefficientToTabular(Convection) (p. 700) No details are provided for this
entry.
Method SwitchToTabular(GenericBoundaryCondition) (p. 701) No details are provided for this
entry.

SwitchAmbientTemperatureToTabular(Convection)
No details are provided for this entry.

Declaration Syntax
public static void SwitchAmbientTemperatureToTabular(Convection BC)

Parameters
BC(Convection)

No details are provided for this entry.

SwitchFilmCoefficientToTabular(Convection)
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
700 of ANSYS, Inc. and its subsidiaries and affiliates.
LocalVonMisesStressConstraint

Declaration Syntax
public static void SwitchFilmCoefficientToTabular(Convection BC)

Parameters
BC(Convection)

No details are provided for this entry.

SwitchToTabular(GenericBoundaryCondition)
No details are provided for this entry.

Declaration Syntax
public static void SwitchToTabular(GenericBoundaryCondition BC)

Parameters
BC(GenericBoundaryCondition)

No details are provided for this entry.

LocalVonMisesStressConstraint
Defines a LocalVonMisesStressConstraint.

Declaration Syntax
public class LocalVonMisesStressConstraint : ResponseConstraint

Table 265: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 702)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 702) Gets the internal object. For advanced usage only.
Property Location (p. 702) Gets or sets the Location.
Property Maximum (p. 702) Gets or sets the Maximum.
Property ScopingMethod (p. 702) Gets or sets the ScopingMethod.
Property Suppressed (p. 989) Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 701
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ResponseConstraint (p. 988).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets or sets the Maximum.

Declaration Syntax
public Field Maximum { get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

ManufacturingConstraint
Defines a ManufacturingConstraint.

Defines a ManufacturingConstraint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
702 of ANSYS, Inc. and its subsidiaries and affiliates.
ManufacturingConstraint

Declaration Syntax
public abstract class ManufacturingConstraint : DataModelObject, IFolderDataModelObject

Table 266: Members

Property Children (p. 703) Gets the list of children.


Property DataModelObjectCategory (p. 703) Gets the current DataModelObject's
category.
Property InternalObject (p. 703) Gets the internal object. For advanced
usage only.
Property Selection (p. 703) Gets or sets the Selection.
Property Suppressed (p. 704) Gets or sets the Suppressed.
Method Delete() (p. 704) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 704)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 704)
Method RenameBasedOnDefinition() (p. 705) Run the RenameBasedOnDefinition action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Selection
Gets or sets the Selection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 703
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public OptimizationRegion Selection { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
704 of ANSYS, Inc. and its subsidiaries and affiliates.
MappingValidation

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

MappingValidation
Defines a MappingValidation.

Declaration Syntax
public class MappingValidation : DataModelObject, IFolderDataModelObject

Table 267: Members

Property ActiveSequence (p. 706) Gets or sets the ActiveSequence.


Property ActiveSequenceByValue (p. 706) Gets or sets the ActiveSequenceByValue.
Property BoundingTolerance (p. 706) Gets or sets the BoundingTolerance.
Property Children (p. 707) Gets the list of children.
Property Comments (p. 707) Gets the list of associated comments.
Property ComplexComponent (p. 707) Gets or sets the ComplexComponent.
Property Component (p. 707) Gets or sets the Component.
Property DataModelObjectCategory (p. 707) Gets the current DataModelObject's category.
Property DefineActiveSequenceBy (p. 707) Control whether the active sequenced is defined
by row or by value.
Property Display (p. 708) No details are provided for this entry.
Property DisplayDataType (p. 708) Gets or sets the DisplayDataType.
Property Figures (p. 708) Gets the list of associated figures.
Property FileIdentifierIndex (p. 708) Gets or sets the FileIdentifierIndex.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 705
Ansys.ACT.Automation.Mechanical Namespace

Property Images (p. 708) Gets the list of associated images.


Property InternalObject (p. 708) Gets the internal object. For advanced usage only.
Property IsolineThickness (p. 709) No details are provided for this entry.
Property IsolineType (p. 709) No details are provided for this entry.
Property Layer (p. 709) Gets or sets the Layer.
Property LegendDivisions (p. 709) No details are provided for this entry.
Property Scale (p. 709) No details are provided for this entry.
Property ShellFace (p. 709) Controls whether the displayed shell face lies on
the bottom, middle, or top of the shell.
Property Type (p. 710) No details are provided for this entry.
Method AddComment() (p. 710) Creates a new child Comment.
Method AddFigure() (p. 710) Creates a new child Figure.
Method AddImage(string) (p. 710) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 710) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 711)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 711)

ActiveSequence
Gets or sets the ActiveSequence.

Declaration Syntax
public int ActiveSequence { set;get; }

ActiveSequenceByValue
Gets or sets the ActiveSequenceByValue.

Declaration Syntax
public double ActiveSequenceByValue { set;get; }

BoundingTolerance
Gets or sets the BoundingTolerance.

Declaration Syntax
public double BoundingTolerance { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
706 of ANSYS, Inc. and its subsidiaries and affiliates.
MappingValidation

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ComplexComponent
Gets or sets the ComplexComponent.

Declaration Syntax
public bool ComplexComponent { set;get; }

Component
Gets or sets the Component.

Declaration Syntax
public ExternalLoadDisplayComponentType Component { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineActiveSequenceBy
Control whether the active sequenced is defined by row or by value.

Declaration Syntax
public ExternalLoadDefineActiveSequenceBy DefineActiveSequenceBy { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 707
Ansys.ACT.Automation.Mechanical Namespace

Display
No details are provided for this entry.

Declaration Syntax
public MappingValidationDisplayOption Display { set;get; }

DisplayDataType
Gets or sets the DisplayDataType.

Declaration Syntax
public ExternalLoadDisplayDataType DisplayDataType { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FileIdentifierIndex
Gets or sets the FileIdentifierIndex.

Declaration Syntax
public int FileIdentifierIndex { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMappingValidationAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
708 of ANSYS, Inc. and its subsidiaries and affiliates.
MappingValidation

IsolineThickness
No details are provided for this entry.

Declaration Syntax
public MappingIsolineThicknessType IsolineThickness { set;get; }

IsolineType
No details are provided for this entry.

Declaration Syntax
public MappingIsolineLineType IsolineType { set;get; }

Layer
Gets or sets the Layer.

Declaration Syntax
public int Layer { set;get; }

LegendDivisions
No details are provided for this entry.

Declaration Syntax
public int LegendDivisions { set;get; }

Scale
No details are provided for this entry.

Declaration Syntax
public double Scale { set;get; }

ShellFace
Controls whether the displayed shell face lies on the bottom, middle, or top of the shell.

Declaration Syntax
public ShellFaceType ShellFace { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 709
Ansys.ACT.Automation.Mechanical Namespace

Type
No details are provided for this entry.

Declaration Syntax
public MappingValidationType Type { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
710 of ANSYS, Inc. and its subsidiaries and affiliates.
MassConstraint

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MassConstraint
Defines a MassConstraint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 711
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class MassConstraint : ResponseConstraint

Table 268: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 712) Gets the current DataModelObject's category.
Property DefineBy (p. 712) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 713) Gets the internal object. For advanced usage only.
Property Location (p. 713) Gets or sets the Location.
Property MaximumAbsoluteValue (p. 713) Gets or sets the MaximumAbsoluteValue.
Property MinimumAbsoluteValue (p. 713) Gets or sets the MinimumAbsoluteValue.
Property PercentageToRetain (p. 713) Gets or sets the PercentageToRetain.
Property PercentageToRetainMax (p. 713) Gets or sets the PercentageToRetainMax.
Property PercentageToRetainMin (p. 714) Gets or sets the PercentageToRetainMin.
Property ScopingMethod (p. 714) Gets or sets the ScopingMethod.
Property Selection (p. 714) Gets or sets the Selection.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineBy
Gets or sets the DefineBy.

Declaration Syntax
public ResponseConstraintDefineBy DefineBy { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
712 of ANSYS, Inc. and its subsidiaries and affiliates.
MassConstraint

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MaximumAbsoluteValue
Gets or sets the MaximumAbsoluteValue.

Declaration Syntax
public Quantity MaximumAbsoluteValue { set;get; }

MinimumAbsoluteValue
Gets or sets the MinimumAbsoluteValue.

Declaration Syntax
public Quantity MinimumAbsoluteValue { set;get; }

PercentageToRetain
Gets or sets the PercentageToRetain.

Declaration Syntax
public int PercentageToRetain { set;get; }

PercentageToRetainMax
Gets or sets the PercentageToRetainMax.

Declaration Syntax
public int PercentageToRetainMax { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 713
Ansys.ACT.Automation.Mechanical Namespace

PercentageToRetainMin
Gets or sets the PercentageToRetainMin.

Declaration Syntax
public int PercentageToRetainMin { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Selection
Gets or sets the Selection.

Declaration Syntax
public OptimizationRegion Selection { set;get; }

Material
Defines a Material.

Declaration Syntax
public class Material : DataModelObject, IRemovableDataModelObject, IFolderDataModelObject

Table 269: Members

Property AssignedBodies (p. 715) Gets the AssignedBodies.


Property Children (p. 715) Gets the list of children.
Property Comments (p. 715) Gets the list of associated comments.
Property DataModelObjectCategory (p. 715) Gets the current DataModelObject's category.
Property Figures (p. 716) Gets the list of associated figures.
Property Images (p. 716) Gets the list of associated images.
Property InternalObject (p. 716) Gets the internal object. For advanced usage only.
Property MaterialModels (p. 716) Returns a collection of the material models that
this material is made up of.
Method AddComment() (p. 716) Creates a new child Comment.
Method AddFigure() (p. 716) Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
714 of ANSYS, Inc. and its subsidiaries and affiliates.
Material

Method AddImage(string) (p. 717) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddMaterialAssignment() (p. 717) Run the AddMaterialAssignment action.
Method CreateMaterialAssignment() Run the CreateMaterialAssignment action.
***OBSOLETE*** Use
'AddMaterialAssignment'
instead (p. 717)
Method GetAsDictionary() (p. 717) Returns material as a python dictionary
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 717)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 718)

AssignedBodies
Gets the AssignedBodies.

Declaration Syntax
public int AssignedBodies { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 715
Ansys.ACT.Automation.Mechanical Namespace

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMaterialAuto InternalObject { get; }

MaterialModels
Returns a collection of the material models that this material is made up of.

Declaration Syntax
public IList<object> MaterialModels { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
716 of ANSYS, Inc. and its subsidiaries and affiliates.
Material

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddMaterialAssignment()
Run the AddMaterialAssignment action.

Declaration Syntax
public virtual MaterialAssignment AddMaterialAssignment()

CreateMaterialAssignment() ***OBSOLETE*** Use 'AddMaterialAssignment'


instead
Run the CreateMaterialAssignment action.

Declaration Syntax
public virtual MaterialAssignment CreateMaterialAssignment()

GetAsDictionary()
Returns material as a python dictionary

Declaration Syntax
public virtual IDictionary<object, object> GetAsDictionary()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 717
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MaterialAssignment
Defines a MaterialAssignment.

Declaration Syntax
public class MaterialAssignment : ImportedDataModelObject, IFolderDataModelObject

Table 270: Members

Property Children (p. 719) Gets the list of children.


Property Comments (p. 719) Gets the list of associated comments.
Property DataModelObjectCategory (p. 720) Gets the current DataModelObject's category.
Property FieldCoordinateSystem (p. 720) Gets or sets the FieldCoordinateSystem.
Property Figures (p. 720) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
718 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialAssignment

Property Images (p. 720) Gets the list of associated images.


Property InternalObject (p. 720) Gets the internal object. For advanced usage only.
Property Location (p. 720) Gets or sets the Location.
Property Material (p. 721) Gets or sets the Material.
Property MaterialName ***OBSOLETE*** Use Gets or sets the MaterialName.
'Material' property instead. (p. 721)
Property MaterialPolarizationDirection (p. 721) Gets or sets the MaterialPolarizationDirection.
Property NonlinearEffects (p. 721) Gets or sets the NonlinearEffects.
Property ReferenceTemperatureValue (p. 721) Gets or sets the ReferenceTemperatureValue.
Property Suppressed (p. 721) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 722) Gets or sets the ThermalStrainEffects.
Property UseReferenceTemperatureByBody (p. 722) Gets or sets the UseReferenceTemperatureByBody.
Method AddCommandSnippet() (p. 722) Creates a new CommandSnippet
Method AddComment() (p. 722) Creates a new child Comment.
Method AddFigure() (p. 722) Creates a new child Figure.
Method AddImage(string) (p. 722) Creates a new child Image. If a filePath is
provided, the image will be loaded from that file,
if not, the image will be a screen capture of the
Geometry window.
Method CreateMaterialPlot() (p. 723) Run the CreateMaterialPlot action.
Method Delete() (p. 723) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 723)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 723)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 719
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FieldCoordinateSystem
Gets or sets the FieldCoordinateSystem.

Declaration Syntax
public CoordinateSystem FieldCoordinateSystem { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMaterialAssignmentAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
720 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialAssignment

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaterialName ***OBSOLETE*** Use 'Material' property instead.


Gets or sets the MaterialName.

Declaration Syntax
public string MaterialName { set;get; }

MaterialPolarizationDirection
Gets or sets the MaterialPolarizationDirection.

Declaration Syntax
public MaterialPolarizationDirection MaterialPolarizationDirection { set;get; }

NonlinearEffects
Gets or sets the NonlinearEffects.

Declaration Syntax
public bool NonlinearEffects { set;get; }

ReferenceTemperatureValue
Gets or sets the ReferenceTemperatureValue.

Declaration Syntax
public Quantity ReferenceTemperatureValue { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 721
Ansys.ACT.Automation.Mechanical Namespace

ThermalStrainEffects
Gets or sets the ThermalStrainEffects.

Declaration Syntax
public bool ThermalStrainEffects { set;get; }

UseReferenceTemperatureByBody
Gets or sets the UseReferenceTemperatureByBody.

Declaration Syntax
public bool UseReferenceTemperatureByBody { set;get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
722 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialAssignment

Parameters
filePath(string)

Full path of file. Defaults to None.

CreateMaterialPlot()
Run the CreateMaterialPlot action.

Declaration Syntax
public virtual MaterialPlot CreateMaterialPlot()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 723
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MaterialPlot
Defines a MaterialPlot.

Declaration Syntax
public class MaterialPlot : DataModelObject, IFolderDataModelObject

Table 271: Members

Property Children (p. 725) Gets the list of children.


Property DataModelObjectCategory (p. 725) Gets the current DataModelObject's
category.
Property InternalObject (p. 725) Gets the internal object. For advanced
usage only.
Property Location (p. 725) Gets or sets the Location.
Property MaterialProperty (p. 725) Gets or sets the MaterialProperty.
Property MaterialPropertyComponent (p. 725) Gets or sets the
MaterialPropertyComponent.
Property Suppressed (p. 726) Gets or sets the Suppressed.
Method Clear() (p. 726) Run the Clear action.
Method Delete() (p. 726) Run the Delete action.
Method Generate() (p. 726) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 726)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 727)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
724 of ANSYS, Inc. and its subsidiaries and affiliates.
MaterialPlot

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMaterialPlotAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MaterialProperty
Gets or sets the MaterialProperty.

Declaration Syntax
public string MaterialProperty { set;get; }

MaterialPropertyComponent
Gets or sets the MaterialPropertyComponent.

Declaration Syntax
public string MaterialPropertyComponent { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 725
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Clear()
Run the Clear action.

Declaration Syntax
public virtual void Clear()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Generate()
Run the Generate action.

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
726 of ANSYS, Inc. and its subsidiaries and affiliates.
Materials

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Materials
Defines a Materials.

Declaration Syntax
public class Materials : ImportedDataModelObject, IFolderDataModelObject

Table 272: Members

Property Children (p. 728) Gets the list of children.


Property Comments (p. 728) Gets the list of associated comments.
Property DataModelObjectCategory (p. 728) Gets the current DataModelObject's category.
Property Figures (p. 728) Gets the list of associated figures.
Property Images (p. 729) Gets the list of associated images.
Property InternalObject (p. 729) Gets the internal object. For advanced usage only.
Property MaterialAssignments (p. 729) Gets the MaterialAssignments.
Property MaterialCount (p. 729) Gets the MaterialCount.
Method AddComment() (p. 729) Creates a new child Comment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 727
Ansys.ACT.Automation.Mechanical Namespace

Method AddFigure() (p. 729) Creates a new child Figure.


Method AddImage(string) (p. 730) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddImportedTraceExternalData() (p. 730) Creates a new Imported Trace (External Data).
Method AddMaterialAssignment() (p. 730) Creates a new MaterialAssignment
Method AddMaterialCombination() (p. 730) Creates a new MaterialCombination
Method AddMaterialPlot() (p. 730) Creates a new MaterialPlot
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 731)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 731)
Method Import(string, ImportFormat, No details are provided for this entry.
ImportSettings) (p. 731)
Method RefreshMaterials() (p. 732) Run the RefreshMaterials action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
728 of ANSYS, Inc. and its subsidiaries and affiliates.
Materials

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMaterialGroupAuto InternalObject { get; }

MaterialAssignments
Gets the MaterialAssignments.

Declaration Syntax
public int MaterialAssignments { get; }

MaterialCount
Gets the MaterialCount.

Declaration Syntax
public int MaterialCount { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 729
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImportedTraceExternalData()
Creates a new Imported Trace (External Data).

Declaration Syntax
public virtual ImportedTraceGroup AddImportedTraceExternalData()

AddMaterialAssignment()
Creates a new MaterialAssignment

Declaration Syntax
public virtual MaterialAssignment AddMaterialAssignment()

AddMaterialCombination()
Creates a new MaterialCombination

Declaration Syntax
public virtual MaterialCombination AddMaterialCombination()

AddMaterialPlot()
Creates a new MaterialPlot

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
730 of ANSYS, Inc. and its subsidiaries and affiliates.
Materials

Declaration Syntax
public virtual MaterialPlot AddMaterialPlot()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Import(string, ImportFormat, ImportSettings)


No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 731
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IEnumerable<Material> Import(string materialURI, ImportFormat format, ImportSettings
settings)

Parameters
materialURI(string)

No details are provided for this entry.

format(ImportFormat)

No details are provided for this entry.

settings(ImportSettings)

No details are provided for this entry.

RefreshMaterials()
Run the RefreshMaterials action.

Declaration Syntax
public virtual void RefreshMaterials()

Measures
Defines a Measures.

Declaration Syntax
public class Measures : DataModelObject, IEvaluateAllResults, IFolderDataModelObject

Table 273: Members

Property Children (p. 733) Gets the list of children.


Property Comments (p. 733) Gets the list of associated comments.
Property DataModelObjectCategory (p. 733) Gets the current DataModelObject's category.
Property Figures (p. 733) Gets the list of associated figures.
Property Images (p. 733) Gets the list of associated images.
Property InternalObject (p. 734) Gets the internal object. For advanced usage only.
Method AddComment() (p. 734) Creates a new child Comment.
Method AddCompositeCriterion() (p. 734) Creates a new CompositeCriterion
Method AddFigure() (p. 734) Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
732 of ANSYS, Inc. and its subsidiaries and affiliates.
Measures

Method AddImage(string) (p. 734) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddPrimaryCriterion() (p. 735) Creates a new PrimaryCriterion
Method Delete() (p. 735) Run the Delete action.
Method EvaluateAllResults() (p. 735) Evaluate all measures.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 735)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 736)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 733
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeasureGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCompositeCriterion()
Creates a new CompositeCriterion

Declaration Syntax
public virtual CompositeCriterion AddCompositeCriterion()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
734 of ANSYS, Inc. and its subsidiaries and affiliates.
Measures

Parameters
filePath(string)

Full path of file. Defaults to None.

AddPrimaryCriterion()
Creates a new PrimaryCriterion

Declaration Syntax
public virtual PrimaryCriterion AddPrimaryCriterion()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Evaluate all measures.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 735
Ansys.ACT.Automation.Mechanical Namespace

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MemberSizeManufacturingConstraint
Defines a MemberSizeManufacturingConstraint.

Declaration Syntax
public class MemberSizeManufacturingConstraint : ManufacturingConstraint

Table 274: Members

Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property DataModelObjectCategory (p. 737)Gets the current DataModelObject's
category.
Property GapSize (p. 737) Gets or sets the GapSize.
Property GapSizeControlledType (p. 737) Gets or sets the GapSizeControlledType.
Property InternalObject (p. 737) Gets the internal object. For advanced usage
only.
Property Location (p. 737) Gets or sets the Location.
Property Maximum (p. 738) Gets or sets the Maximum.
Property MaxSize (p. 738) Gets or sets the MaxSize.
Property Minimum (p. 738) Gets or sets the Minimum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
736 of ANSYS, Inc. and its subsidiaries and affiliates.
MemberSizeManufacturingConstraint

Property MinSize (p. 738) Gets or sets the MinSize.


Property ScopingMethod (p. 738) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

GapSize
Gets or sets the GapSize.

Declaration Syntax
public Quantity GapSize { set;get; }

GapSizeControlledType
Gets or sets the GapSizeControlledType.

Declaration Syntax
public ManuMemberSizeControlledType GapSizeControlledType { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 737
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets or sets the Maximum.

Declaration Syntax
public ManuMemberSizeControlledType Maximum { set;get; }

MaxSize
Gets or sets the MaxSize.

Declaration Syntax
public Quantity MaxSize { set;get; }

Minimum
Gets or sets the Minimum.

Declaration Syntax
public ManuMemberSizeControlledType Minimum { set;get; }

MinSize
Gets or sets the MinSize.

Declaration Syntax
public Quantity MinSize { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

MeshConnection
Defines a MeshConnection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
738 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnection

Declaration Syntax
public class MeshConnection : MeshConnectionBase

Table 275: Members

Property Children (p. 743) Gets the list of children.

(Inherited from
MeshConnectionBase (p. 742).)
Property Comments (p. 743) Gets the list of associated comments.

(Inherited from
MeshConnectionBase (p. 742).)
Property ContactRegion (p. 740) Gets or sets the ContactRegion.
Property DataModelObjectCategory (p. 740)Gets the current DataModelObject's
category.
Property Figures (p. 743) Gets the list of associated figures.

(Inherited from
MeshConnectionBase (p. 742).)
Property Images (p. 743) Gets the list of associated images.

(Inherited from
MeshConnectionBase (p. 742).)
Property InternalObject (p. 741) Gets the internal object. For advanced usage
only.
Property MasterBodies (p. 744) Gets the MasterBodies.

(Inherited from
MeshConnectionBase (p. 742).)
Property MasterElementSizeFactor (p. 741) Gets or sets the MasterElementSizeFactor.
Property MasterLocation (p. 744) Gets or sets the MasterLocation.

(Inherited from
MeshConnectionBase (p. 742).)
Property ScopeMode (p. 744) Gets the ScopeMode.

(Inherited from
MeshConnectionBase (p. 742).)
Property ScopingMethod (p. 744) No details are provided for this entry.

(Inherited from
MeshConnectionBase (p. 742).)
Property SlaveBodies (p. 744) Gets the SlaveBodies.

(Inherited from
MeshConnectionBase (p. 742).)
Property SlaveLocation (p. 744) Gets or sets the SlaveLocation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 739
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
MeshConnectionBase (p. 742).)
Property SnapToBoundary (p. 745) Gets or sets the SnapToBoundary.

(Inherited from
MeshConnectionBase (p. 742).)
Property SnapTolerance (p. 745) Gets or sets the SnapTolerance.

(Inherited from
MeshConnectionBase (p. 742).)
Property SnapType (p. 745) Gets or sets the SnapType.

(Inherited from
MeshConnectionBase (p. 742).)
Property Suppressed (p. 745) Gets or sets the Suppressed.

(Inherited from
MeshConnectionBase (p. 742).)
Property ThicknessScaleFactor (p. 741) Gets or sets the ThicknessScaleFactor.
Property ToleranceSlider (p. 745) Gets or sets the ToleranceSlider.

(Inherited from
MeshConnectionBase (p. 742).)
Property ToleranceType (p. 745) Gets or sets the ToleranceType.

(Inherited from
MeshConnectionBase (p. 742).)
Property ToleranceValue (p. 741) Gets or sets the ToleranceValue.
Method CreateNamedSelection() (p. 741) No details are provided for this entry.
Method FlipMasterSlave() (p. 741) No details are provided for this entry.

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
740 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnection

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshConnectionAuto InternalObject { get; }

MasterElementSizeFactor
Gets or sets the MasterElementSizeFactor.

Declaration Syntax
public double MasterElementSizeFactor { set;get; }

ThicknessScaleFactor
Gets or sets the ThicknessScaleFactor.

Declaration Syntax
public double ThicknessScaleFactor { set;get; }

ToleranceValue
Gets or sets the ToleranceValue.

Declaration Syntax
public Quantity ToleranceValue { set;get; }

CreateNamedSelection()
No details are provided for this entry.

Declaration Syntax
public virtual IEnumerable<NamedSelection> CreateNamedSelection()

FlipMasterSlave()
No details are provided for this entry.

Declaration Syntax
public virtual void FlipMasterSlave()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 741
Ansys.ACT.Automation.Mechanical Namespace

MeshConnectionBase
Defines a MeshConnectionBase.

Defines a MeshConnectionBase.

Declaration Syntax
public class MeshConnectionBase : DataModelObject, IFolderDataModelObject

Table 276: Members

Property Children (p. 743) Gets the list of children.


Property Comments (p. 743) Gets the list of associated comments.
Property DataModelObjectCategory (p. 743) Gets the current DataModelObject's category.
Property Figures (p. 743) Gets the list of associated figures.
Property Images (p. 743) Gets the list of associated images.
Property InternalObject (p. 743) Gets the internal object. For advanced usage only.
Property MasterBodies (p. 744) Gets the MasterBodies.
Property MasterLocation (p. 744) Gets or sets the MasterLocation.
Property ScopeMode (p. 744) Gets the ScopeMode.
Property ScopingMethod (p. 744) No details are provided for this entry.
Property SlaveBodies (p. 744) Gets the SlaveBodies.
Property SlaveLocation (p. 744) Gets or sets the SlaveLocation.
Property SnapToBoundary (p. 745) Gets or sets the SnapToBoundary.
Property SnapTolerance (p. 745) Gets or sets the SnapTolerance.
Property SnapType (p. 745) Gets or sets the SnapType.
Property Suppressed (p. 745) Gets or sets the Suppressed.
Property ToleranceSlider (p. 745) Gets or sets the ToleranceSlider.
Property ToleranceType (p. 745) Gets or sets the ToleranceType.
Method AddComment() (p. 746) Creates a new child Comment.
Method AddFigure() (p. 746) Creates a new child Figure.
Method AddImage(string) (p. 746) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 746) Run the Delete action.
Method Generate() (p. 746) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 747)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 747)
Method RenameBasedOnDefinition() (p. 747) Run the RenameBasedOnDefinition action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
742 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionBase

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshConnectionAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 743
Ansys.ACT.Automation.Mechanical Namespace

MasterBodies
Gets the MasterBodies.

Declaration Syntax
public string MasterBodies { get; }

MasterLocation
Gets or sets the MasterLocation.

Declaration Syntax
public ISelectionInfo MasterLocation { set;get; }

ScopeMode
Gets the ScopeMode.

Declaration Syntax
public AutomaticOrManual ScopeMode { get; }

ScopingMethod
No details are provided for this entry.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SlaveBodies
Gets the SlaveBodies.

Declaration Syntax
public string SlaveBodies { get; }

SlaveLocation
Gets or sets the SlaveLocation.

Declaration Syntax
public ISelectionInfo SlaveLocation { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
744 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionBase

SnapToBoundary
Gets or sets the SnapToBoundary.

Declaration Syntax
public bool SnapToBoundary { set;get; }

SnapTolerance
Gets or sets the SnapTolerance.

Declaration Syntax
public Quantity SnapTolerance { set;get; }

SnapType
Gets or sets the SnapType.

Declaration Syntax
public SnapType SnapType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ToleranceSlider
Gets or sets the ToleranceSlider.

Declaration Syntax
public int ToleranceSlider { set;get; }

ToleranceType
Gets or sets the ToleranceType.

Declaration Syntax
public ContactToleranceType ToleranceType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 745
Ansys.ACT.Automation.Mechanical Namespace

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Generate()
Run the Generate action.

Declaration Syntax
public virtual void Generate()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
746 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionBase

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 747
Ansys.ACT.Automation.Mechanical Namespace

MeshConnectionGroup
Defines a MeshConnectionGroup.

Declaration Syntax
public class MeshConnectionGroup : ConnectionGroup

Table 277: Members

Property ActiveConnections (p. 3562) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 3560).)


Property AutomaticFixedJoints (p. 3562) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 3560).)


Property Children (p. 3562) Gets the list of children.

(Inherited from ConnectionGroup (p. 3560).)


Property Comments (p. 3562) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 3560).)


Property Connections (p. 3563) Gets the Connections.

(Inherited from ConnectionGroup (p. 3560).)


Property ConnectionType (p. 3563) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 3560).)


Property CylindricalFaces (p. 3563) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 3560).)


Property DataModelObjectCategory (p. 750) Gets the current DataModelObject's category.
Property EdgeEdge (p. 3563) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 3560).)


Property EdgeOverlapTolerance (p. 3563) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceAngleTolerance (p. 3564) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceEdge (p. 3564) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceFace (p. 3564) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceFaceDetectionAngleTolerence (p. 3564) Gets or sets the
FaceFaceDetectionAngleTolerence.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
748 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshConnectionGroup

(Inherited from ConnectionGroup (p. 3560).)


Property FaceOverlapTolerance (p. 3564) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property Figures (p. 3564) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 3560).)


Property GroupBy (p. 3565) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 3560).)


Property Images (p. 3565) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 3560).)


Property InternalObject (p. 750) Gets the internal object. For advanced usage
only.
Property Location (p. 3565) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 3560).)


Property MinimumDistancePercentage (p. 3565) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 3560).)


Property MinimumDistanceValue (p. 3565) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 3560).)


Property Priority (p. 3566) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 3560).)


Property RevoluteJoints (p. 3566) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 3560).)


Property SearchAcross (p. 3566) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 3560).)


Property Suppressed (p. 3566) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 3560).)


Property ThicknessScaleFactor (p. 3566) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceSlider (p. 3566) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceType (p. 3567) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceValue (p. 3567) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 3560).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 749
Ansys.ACT.Automation.Mechanical Namespace

Property UseRange (p. 3567) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 3560).)


Method AddManualMeshConnection() (p. 750) Creates a new MeshConnection
Method DetectConnections() (p. 750) Detect mesh connections.
Method Generate() (p. 750) Generate mesh connections.
Method SearchConnectionsForDuplicatePairs() (p. 751) No details are provided for this entry.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSConnectionGroupAuto InternalObject { get; }

AddManualMeshConnection()
Creates a new MeshConnection

Declaration Syntax
public virtual MeshConnection AddManualMeshConnection()

DetectConnections()
Detect mesh connections.

Declaration Syntax
public virtual void DetectConnections()

Generate()
Generate mesh connections.

Declaration Syntax
public virtual void Generate()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
750 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshControlWorksheet

SearchConnectionsForDuplicatePairs()
No details are provided for this entry.

Declaration Syntax
public override void SearchConnectionsForDuplicatePairs()

MeshControlWorksheet
No details are provided for this entry.

Declaration Syntax
public class MeshControlWorksheet : Worksheet

Table 278: Members

Property RowCount (p. 751) Gets the number of entries


Method AddRow() (p. 752) Add a row to the MeshControlWorksheet
Method ClearGenerateMesh() (p. 752) Clear Mesh
Method DeleteAllRows() (p. 752) Delete All Rows
Method DeleteRow(int) (p. 752) Delete a row from the
MeshControlWorksheet
Method GenerateAtRow(int) (p. 752) Generate Mesh At Row
Method GenerateMesh() (p. 753) Geneate Mesh
Method GetActiveState(int) (p. 753) Gets the Active State property at row index
Method GetNamedSelection(int) (p. 753) Gets the NamedSelection at row index
Method GetNamedSelectionId(int) (p. 753) Gets the ID of the NamedSelection at row
index
Method SetActiveState(int, bool) (p. 754) Sets the Active State property at row index
Method SetNamedSelection(int, Sets the NamedSelection at row index
NamedSelection) (p. 754)
Method SetNamedSelectionId(int, uint) (p. 754) Sets the NamedSelection by ID at row index

RowCount
Gets the number of entries

Declaration Syntax
public int RowCount { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 751
Ansys.ACT.Automation.Mechanical Namespace

AddRow()
Add a row to the MeshControlWorksheet

Declaration Syntax
public override int AddRow()

ClearGenerateMesh()
Clear Mesh

Declaration Syntax
public virtual void ClearGenerateMesh()

DeleteAllRows()
Delete All Rows

Declaration Syntax
public virtual void DeleteAllRows()

DeleteRow(int)
Delete a row from the MeshControlWorksheet

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)

No details are provided for this entry.

GenerateAtRow(int)
Generate Mesh At Row

Declaration Syntax
public virtual void GenerateAtRow(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
752 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshControlWorksheet

Parameters
index(int)

No details are provided for this entry.

GenerateMesh()
Geneate Mesh

Declaration Syntax
public virtual void GenerateMesh()

GetActiveState(int)
Gets the Active State property at row index

Declaration Syntax
public virtual bool GetActiveState(int index)

Parameters
index(int)

No details are provided for this entry.

GetNamedSelection(int)
Gets the NamedSelection at row index

Declaration Syntax
public virtual NamedSelection GetNamedSelection(int index)

Parameters
index(int)

No details are provided for this entry.

GetNamedSelectionId(int)
Gets the ID of the NamedSelection at row index

Declaration Syntax
public virtual uint GetNamedSelectionId(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 753
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

No details are provided for this entry.

SetActiveState(int, bool)
Sets the Active State property at row index

Declaration Syntax
public virtual void SetActiveState(int index, bool value)

Parameters
index(int)

No details are provided for this entry.

value(bool)

No details are provided for this entry.

SetNamedSelection(int, NamedSelection)
Sets the NamedSelection at row index

Declaration Syntax
public virtual void SetNamedSelection(int index, NamedSelection value)

Parameters
index(int)

No details are provided for this entry.

value(NamedSelection)

No details are provided for this entry.

SetNamedSelectionId(int, uint)
Sets the NamedSelection by ID at row index

Declaration Syntax
public virtual void SetNamedSelectionId(int index, uint value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
754 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

Parameters
index(int)

No details are provided for this entry.

value(uint)

No details are provided for this entry.

MeshEdit
Defines a MeshEdit.

Declaration Syntax
public class MeshEdit : DataModelObject, IFolderDataModelObject

Table 279: Members

Property AssociateToPullGeometry (p. 756) To Migrate Boundary Conditions from


profile to resulting Pull bodies.
Property Children (p. 756) Gets the list of children.
Property Comments (p. 756) Gets the list of associated comments.
Property DataModelObjectCategory (p. 756) Gets the current DataModelObject's
category.
Property Figures (p. 757) Gets the list of associated figures.
Property GenerateAutomaticMeshConnectionsOnRefresh (p. 757) Gets or sets the
GenerateAutomaticMeshConnectionsOnRefresh.
Property Images (p. 757) Gets the list of associated images.
Property InternalObject (p. 757) Gets the internal object. For advanced
usage only.
Property TransparencyEnabled (p. 757) Gets or sets the TransparencyEnabled.
Method AddComment() (p. 757) Creates a new child Comment.
Method AddContactMatchGroup() (p. 758) Creates a new ContactMatchGroup
Method AddDirectMorph() (p. 758) Creates a new DirectMorph
Method AddFigure() (p. 758) Creates a new child Figure.
Method AddImage(string) (p. 758) Creates a new child Image. If a filePath is
provided, the image will be loaded from
that file, if not, the image will be a screen
capture of the Geometry window.
Method AddManualMeshConnection() (p. 758) Add a new ManualMeshConnection
Method AddMeshConnectionGroup() (p. 759) Creates a new MeshConnectionGroup
Method AddNodeMerge() (p. 759) Add a new NodeMerge.
Method AddNodeMergeGroup() (p. 759) Creates a new NodeMergeGroup

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 755
Ansys.ACT.Automation.Mechanical Namespace

Method AddNodeMove() (p. 759) Creates a new NodeMove


Method AddPullExtrude() (p. 759) Creates a new MeshExtrude
Method AddPullRevolve() (p. 759) Creates a new MeshExtrude
Method AddPullSurfaceCoating() (p. 760) Creates a new MeshExtrude
Method ClearGeneratedData() (p. 760) Clear the generated data.
Method CreateNamedSelectionForSharedNodes() (p. 760) Run the
CreateNamedSelectionForSharedNodes
action.
Method Generate() (p. 760) Generate all mesh edits.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 760)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 761)
Method RenameBasedOnDefinition() (p. 761) Run the RenameBasedOnDefinition action.
Method SearchConnectionsForDuplicatePairs() (p. 761) Run the
SearchConnectionsForDuplicatePairs
action.

AssociateToPullGeometry
To Migrate Boundary Conditions from profile to resulting Pull bodies.

Declaration Syntax
public bool AssociateToPullGeometry { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
756 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerateAutomaticMeshConnectionsOnRefresh
Gets or sets the GenerateAutomaticMeshConnectionsOnRefresh.

Declaration Syntax
public AutomaticOrManual GenerateAutomaticMeshConnectionsOnRefresh { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshConnectionsParentAuto InternalObject { get; }

TransparencyEnabled
Gets or sets the TransparencyEnabled.

Declaration Syntax
public bool TransparencyEnabled { set;get; }

AddComment()
Creates a new child Comment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 757
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Comment AddComment()

AddContactMatchGroup()
Creates a new ContactMatchGroup

Declaration Syntax
public virtual ContactMatchGroup AddContactMatchGroup()

AddDirectMorph()
Creates a new DirectMorph

Declaration Syntax
public virtual DirectMorph AddDirectMorph()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddManualMeshConnection()
Add a new ManualMeshConnection

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
758 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

Declaration Syntax
public virtual void AddManualMeshConnection()

AddMeshConnectionGroup()
Creates a new MeshConnectionGroup

Declaration Syntax
public virtual MeshConnectionGroup AddMeshConnectionGroup()

AddNodeMerge()
Add a new NodeMerge.

Declaration Syntax
public virtual void AddNodeMerge()

AddNodeMergeGroup()
Creates a new NodeMergeGroup

Declaration Syntax
public virtual NodeMergeGroup AddNodeMergeGroup()

AddNodeMove()
Creates a new NodeMove

Declaration Syntax
public virtual NodeMove AddNodeMove()

AddPullExtrude()
Creates a new MeshExtrude

Declaration Syntax
public virtual MeshExtrude AddPullExtrude()

AddPullRevolve()
Creates a new MeshExtrude

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 759
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual MeshExtrude AddPullRevolve()

AddPullSurfaceCoating()
Creates a new MeshExtrude

Declaration Syntax
public virtual MeshExtrude AddPullSurfaceCoating()

ClearGeneratedData()
Clear the generated data.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateNamedSelectionForSharedNodes()
Run the CreateNamedSelectionForSharedNodes action.

Declaration Syntax
public virtual void CreateNamedSelectionForSharedNodes()

Generate()
Generate all mesh edits.

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
760 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshEdit

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

SearchConnectionsForDuplicatePairs()
Run the SearchConnectionsForDuplicatePairs action.

Declaration Syntax
public virtual void SearchConnectionsForDuplicatePairs()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 761
Ansys.ACT.Automation.Mechanical Namespace

MeshExtrude
Pull method enables you to extrude or revolve element faces, topofaces or scoped bodies (only shell
body) from a surface or solid mesh. Pull also allows to create surface coating on solid bodies, element
faces and topofaces.

Declaration Syntax
public class MeshExtrude : DataModelObject, IFolderDataModelObject

Table 280: Members

Property AxisOfRevolution (p. 764) To select the coordinate axis along which the
selected elements can be revolved. The available
options are X Axis, Y Axis, Z Axis.
Property Children (p. 764) Gets the list of children.
Property Comments (p. 764) Gets the list of associated comments.
Property CoordinateSystem (p. 764) To generate elements in the specified coordinate
system. The Coordinate System allows to select the
Global Coordinate System by default.
Property DataModelObjectCategory (p. 764) Gets the current DataModelObject's category.
Property ElementOption (p. 764) Gets or sets the ElementOption.
Property ExtrudeBy (p. 765) To specify the method of Extrude. The available
options are Use Coordinate System and Face
Normal.
Property FeatureAngle (p. 765) To specify feature angle for splitting side faces.
Property Figures (p. 765) Gets the list of associated figures.
Property Height (p. 765) To specify the height for the volume of solid
elements in the method of Extrude.
Property Images (p. 765) Gets the list of associated images.
Property InternalObject (p. 765) Gets the internal object. For advanced usage only.
Property Location (p. 766) Allows you to scope elements, element faces,
topofaces and sheet bodies for Extrude or Revolve.
Also, scopes element faces, topofaces and solid
bodies for Surface Coating.
Property Material (p. 766) To select the material of your choice. You can also
select a different material from the parent body
material.
Property MergeProfileNodes (p. 766) To merge nodes on the profile body and pull
generated body.
Property Method (p. 766) To select the method of Pull. There are three
methods. They are Extrude, Revolve and Surface
Coating.
Property NonlinearMaterialEffects (p. 766) Gets or sets the NonlinearMaterialEffects.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
762 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshExtrude

Property NumberOfLayers (p. 767) To specify the number of layers to be used for
Extrude and Revolve.
Property RevolutionAngle (p. 767) To specify angle of revolution for the solid elements
in the method of Revolve.
Property ScopingMethod (p. 767) Defines what type of selection this object is scoped
to.
Property StiffnessOption (p. 767) To provide the stiffness option of the shell body
created by surface coating. The available options
are Stress Evaluation Only, Membrane Only,
Membrane and Bending.
Property Suppressed (p. 767) To suppress the selected entities. You can select
Yes to suppress the selected entities and No to
unsuppress the selected entities. The default value
is No.
Property ThermalStrainCalculation (p. 767) Gets or sets the ThermalStrainCalculation.
Property Thickness (p. 768) To specify the thickness for surface coating. The
Thickness option is available only when the
Stiffness Behavior is set to Membrane Only or
Membrane and Bending.
Property UpTo (p. 768) To generate elements up to the specified target.
The target can be faces from solids or sheet bodies
and multiple faces with sharing topoedge.
Property UpToTarget (p. 768) The target can be faces from solids or sheet bodies
and multiple faces with sharing topoedge in
Extrude UpTo.
Property UseCoordinateSystem (p. 768) The Use Coordinate System allows to select any of
the XYZ coordinate axis in the method of Extrude.
Property UseFeatureAngle (p. 768) To split side faces by speficied feature angle.
Method AddComment() (p. 769) Creates a new child Comment.
Method AddFigure() (p. 769) Creates a new child Figure.
Method AddImage(string) (p. 769) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 769) Clear generated data.
Method Delete() (p. 769) Run the Delete action.
Method Generate() (p. 770) Generate selected mesh pull.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 770)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 770)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 763
Ansys.ACT.Automation.Mechanical Namespace

AxisOfRevolution
To select the coordinate axis along which the selected elements can be revolved. The available options
are X Axis, Y Axis, Z Axis.

Declaration Syntax
public CoordinateSystemAxisType AxisOfRevolution { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
To generate elements in the specified coordinate system. The Coordinate System allows to select the
Global Coordinate System by default.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementOption
Gets or sets the ElementOption.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
764 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshExtrude

Declaration Syntax
public SweepElementOptionType ElementOption { set;get; }

ExtrudeBy
To specify the method of Extrude. The available options are Use Coordinate System and Face Normal.

Declaration Syntax
public ExtrudeBy ExtrudeBy { set;get; }

FeatureAngle
To specify feature angle for splitting side faces.

Declaration Syntax
public Quantity FeatureAngle { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Height
To specify the height for the volume of solid elements in the method of Extrude.

Declaration Syntax
public Quantity Height { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 765
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSMeshExtrudeAuto InternalObject { get; }

Location
Allows you to scope elements, element faces, topofaces and sheet bodies for Extrude or Revolve.
Also, scopes element faces, topofaces and solid bodies for Surface Coating.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Material
To select the material of your choice. You can also select a different material from the parent body
material.

Declaration Syntax
public string Material { set;get; }

MergeProfileNodes
To merge nodes on the profile body and pull generated body.

Declaration Syntax
public bool MergeProfileNodes { set;get; }

Method
To select the method of Pull. There are three methods. They are Extrude, Revolve and Surface Coating.

Declaration Syntax
public PullMethod Method { set;get; }

NonlinearMaterialEffects
Gets or sets the NonlinearMaterialEffects.

Declaration Syntax
public bool NonlinearMaterialEffects { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
766 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshExtrude

NumberOfLayers
To specify the number of layers to be used for Extrude and Revolve.

Declaration Syntax
public int NumberOfLayers { set;get; }

RevolutionAngle
To specify angle of revolution for the solid elements in the method of Revolve.

Declaration Syntax
public Quantity RevolutionAngle { set;get; }

ScopingMethod
Defines what type of selection this object is scoped to.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

StiffnessOption
To provide the stiffness option of the shell body created by surface coating. The available options
are Stress Evaluation Only, Membrane Only, Membrane and Bending.

Declaration Syntax
public ShellElementStiffnessOption StiffnessOption { set;get; }

Suppressed
To suppress the selected entities. You can select Yes to suppress the selected entities and No to un-
suppress the selected entities. The default value is No.

Declaration Syntax
public bool Suppressed { set;get; }

ThermalStrainCalculation
Gets or sets the ThermalStrainCalculation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 767
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool ThermalStrainCalculation { set;get; }

Thickness
To specify the thickness for surface coating. The Thickness option is available only when the Stiffness
Behavior is set to Membrane Only or Membrane and Bending.

Declaration Syntax
public Quantity Thickness { set;get; }

UpTo
To generate elements up to the specified target. The target can be faces from solids or sheet bodies
and multiple faces with sharing topoedge.

Declaration Syntax
public bool UpTo { set;get; }

UpToTarget
The target can be faces from solids or sheet bodies and multiple faces with sharing topoedge in Extrude
UpTo.

Declaration Syntax
public ISelectionInfo UpToTarget { set;get; }

UseCoordinateSystem
The Use Coordinate System allows to select any of the XYZ coordinate axis in the method of Extrude.

Declaration Syntax
public CoordinateSystemAxisType UseCoordinateSystem { set;get; }

UseFeatureAngle
To split side faces by speficied feature angle.

Declaration Syntax
public bool UseFeatureAngle { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
768 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshExtrude

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Clear generated data.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 769
Ansys.ACT.Automation.Mechanical Namespace

Generate()
Generate selected mesh pull.

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
770 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshNumbering

MeshNumbering
Defines a MeshNumbering.

Declaration Syntax
public class MeshNumbering : DataModelObject, IFolderDataModelObject

Table 281: Members

Property Children (p. 771) Gets the list of children.


Property Comments (p. 771) Gets the list of associated comments.
Property CompressNodeNumbers (p. 772) Gets or sets the CompressNodeNumbers.
Property DataModelObjectCategory (p. 772) Gets the current DataModelObject's category.
Property ElementOffset (p. 772) Gets or sets the ElementOffset.
Property Figures (p. 772) Gets the list of associated figures.
Property Images (p. 772) Gets the list of associated images.
Property InternalObject (p. 772) Gets the internal object. For advanced usage only.
Property NodeOffset (p. 773) Gets or sets the NodeOffset.
Property Suppressed (p. 773) Gets or sets the Suppressed.
Method AddComment() (p. 773) Creates a new child Comment.
Method AddFigure() (p. 773) Creates a new child Figure.
Method AddImage(string) (p. 773) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddNumberingControl() (p. 774) Creates a new NumberingControl
Method Delete() (p. 774) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 774)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 774)
Method RenumberMesh() (p. 775) Run the RenumberMesh action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 771
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CompressNodeNumbers
Gets or sets the CompressNodeNumbers.

Declaration Syntax
public bool CompressNodeNumbers { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementOffset
Gets or sets the ElementOffset.

Declaration Syntax
public uint ElementOffset { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
772 of ANSYS, Inc. and its subsidiaries and affiliates.
MeshNumbering

Declaration Syntax
public IDSMeshRenumberingControlGroupAuto InternalObject { get; }

NodeOffset
Gets or sets the NodeOffset.

Declaration Syntax
public uint NodeOffset { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 773
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filePath(string)

Full path of file. Defaults to None.

AddNumberingControl()
Creates a new NumberingControl

Declaration Syntax
public virtual NumberingControl AddNumberingControl()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
774 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenumberMesh()
Run the RenumberMesh action.

Declaration Syntax
public virtual void RenumberMesh()

Model
Defines a Model.

Declaration Syntax
public class Model : DataModelObject, IFolderDataModelObject

Table 282: Members

Property AEDTImportManager (p. 781) Get the manager for manipulating


import settings for AEDT files.
Property Ambient (p. 781) Gets or sets the Ambient Lighting
factor.
Property AMProcess (p. 782) Gets the AMProcess.
Property Analyses (p. 782) Gets the Analyses.
Property CellId (p. 782) Gets the CellId.
Property Children (p. 782) Gets the list of children.
Property Color (p. 782) Gets or sets the Lighting Color. Can
also be set using Hex color codes;

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 775
Ansys.ACT.Automation.Mechanical Namespace

three byte hexadecimal numbers


(consisting of six digits) preceded
by '0x', where each byte (or pair of
characters in the Hex code)
represents the intensity of red,
green and blue in the color
respectively. For example,
0xFFFFFF.
Property Comments (p. 782) Gets the list of associated
comments.
Property CondensedGeometry (p. 783) Gets the CondensedGeometry.
Property Connections (p. 783) Gets the Connections.
Property ConstructionGeometry (p. 783) Gets the ConstructionGeometry.
Property Control (p. 783) Gets the Control.
Property CoordinateSystems (p. 783) Gets the CoordinateSystems.
Property CrossSections (p. 783) Gets the CrossSections.
Property DataModelObjectCategory (p. 784) Gets the current DataModelObject's
category.
Property Diffuse (p. 784) Gets or sets the Diffuse Lighting
factor.
Property Environments ***OBSOLETE*** Use 'Analyses' property Gets the Analyses.
instead. (p. 784)
Property FeatureDetection (p. 784) Gets the FeatureDetection.
Property Figures (p. 784) Gets the list of associated figures.
Property Fracture (p. 784) Gets the Fracture.
Property Geometry (p. 785) Gets the Geometry.
Property GeometryImportGroup (p. 785) Gets the GeometryImportGroup.
Property Images (p. 785) Gets the list of associated images.
Property InternalObject (p. 785) Gets the internal object. For
advanced usage only.
Property Materials (p. 785) Gets the Materials.
Property Measures (p. 785) Gets the Measures.
Property Mesh (p. 786) Gets the Mesh.
Property MeshEdit (p. 786) Gets the MeshEdit.
Property MeshNumbering (p. 786) Gets the MeshNumbering.
Property NamedSelections (p. 786) Gets the NamedSelections.
Property PartTransformGroup (p. 786) Gets the PartTransformGroup.
Property RemotePoints (p. 786) Gets the RemotePoints.
Property Specular (p. 787) Gets or sets the Specular Lighting
factor.
Property Symmetry (p. 787) Gets the Symmetry.
Property SystemCaption (p. 787) Gets the SystemCaption.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
776 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Property TableGroup (p. 787) Gets the TableGroup.


Property VirtualTopology (p. 787) Gets the VirtualTopology.
Method AddAMProcess() (p. 787) Creates a new AMProcess
Method AddChart() (p. 788) Creates a new child Chart.
Method AddComment() (p. 788) Creates a new child Comment.
Method AddCompositeFailureCriteria() (p. 788) Creates a new Composite Failure
Criteria object.
Method AddCondensedGeometry() (p. 788) Creates a new CondensedGeometry
Method AddConnections() (p. 788) Creates a new Connections
Method AddConstructionGeometry() (p. 788) Creates a new
ConstructionGeometry
Method AddCoSimulationPin() (p. 789) Creates a new CoSimulationPin
Method AddCoupledFieldHarmonic() (p. 789) Run the AddCoupledFieldHarmonic
action.
Method AddCoupledFieldModal() (p. 789) Run the AddCoupledFieldModal
action.
Method AddCoupledFieldStatic() (p. 789) Run the AddCoupledFieldStatic
action.
Method AddCoupledFieldTransient() (p. 789) Run the AddCoupledFieldTransient
action.
Method AddCrossSections() (p. 789) Creates new CrossSections group.
Method AddDesignAssessmentAnalysis() (p. 790) Run the
AddDesignAssessmentAnalysis
action.
Method AddDesignLifeAnalysis() (p. 790) Run the AddDesignLifeAnalysis
action.
Method AddEigenvalueBucklingAnalysis() (p. 790) Run the
AddEigenvalueBucklingAnalysis
action.
Method AddElectricAnalysis() (p. 790) Run the AddElectricAnalysis action.
Method AddExplicitDynamicsAnalysis() (p. 790) Run the
AddExplicitDynamicsAnalysis
action.
Method AddFatigueCombination() (p. 790) Creates a new FatigueCombination
Method AddFeatureDetection() (p. 791) Creates a new FeatureDetection
Method AddFigure() (p. 791) Creates a new child Figure.
Method AddForcedResponseAnalysis() (p. 791) Run the
AddForcedResponseAnalysis action.
Method AddFracture() (p. 791) Creates a new Fracture
Method AddGeometryImportGroup() (p. 791) Get the

GeometryImportGroup instance.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 777
Ansys.ACT.Automation.Mechanical Namespace

Method AddHarmonicAcousticAnalysis() (p. 792) Run the


AddHarmonicAcousticAnalysis
action.
Method AddHarmonicResponseAnalysis() (p. 792) Run the
AddHarmonicResponseAnalysis
action.
Method AddImage(string) (p. 792) Creates a new child Image. If a
filePath is provided, the image will
be loaded from that file, if not, the
image will be a screen capture of
the Geometry window.
Method AddImagePlane() (p. 792) Creates an ImagePlane and adds it
as a child of this object.
Method AddLSDynaAnalysis() (p. 792) Run the AddLSDynaAnalysis action.
Method AddLSDynaRestartAnalysis() (p. 793) Run the AddLSDynaRestartAnalysis
action.
Method AddMagnetostaticAnalysis() (p. 793) Run the AddMagnetostaticAnalysis
action.
Method AddMeasures() (p. 793) Creates a new Measures
Method AddMeshEdit() (p. 793) Creates a new MeshEdit
Method AddMeshNumbering() (p. 793) Creates a new MeshNumbering
Method AddModalAcousticAnalysis() (p. 793) Run the AddModalAcousticAnalysis
action.
Method AddModalAnalysis() (p. 794) Run the AddModalAnalysis action.
Method AddMotionAnalysis() (p. 794) Run the AddMotionAnalysis action.
Method AddNamedSelection() (p. 794) Creates a new child
NamedSelection.
Method AddNamedSelectionFromSelectedConnections() (p. 794) Creates a new Named Selections
(Components) for the selected
connections.
Method AddPartTransform() (p. 794) Creates a new child PartTransform.
Method AddPythonCodeEventBased() (p. 794) Creates a new
PythonCodeEventBased
Method AddPythonResult() (p. 795) Creates a new PythonResult
Method AddRandomVibrationAnalysis() (p. 795) Run the
AddRandomVibrationAnalysis
action.
Method AddRemotePoint() (p. 795) Creates a new child RemotePoint.
Method AddResponseSpectrumAnalysis() (p. 795) Run the
AddResponseSpectrumAnalysis
action.
Method AddRigidDynamicsAnalysis() (p. 795) Run the AddRigidDynamicsAnalysis
action.
Method AddSolutionCombination() (p. 795) Creates a new SolutionCombination

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
778 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Method AddStaticAcousticAnalysis() (p. 796) Run the AddStaticAcousticAnalysis


action.
Method AddStaticStructuralAnalysis() (p. 796) Run the AddStaticStructuralAnalysis
action.
Method AddSteadyStateThermalAnalysis() (p. 796) Run the
AddSteadyStateThermalAnalysis
action.
Method AddSubstructureGenerationAnalysis() (p. 796) Run the
AddSubstructureGenerationAnalysis
action.
Method AddSymmetry() (p. 796) Creates a new Symmetry
Method AddTableGroup(bool) (p. 796) Get the

TableGroup instance.
Method AddThermalElectricAnalysis() (p. 797) Run the AddThermalElectricAnalysis
action.
Method AddTopologyOptimizationAnalysis() (p. 797) Run the
AddTopologyOptimizationAnalysis
action.
Method AddTransientStructuralAnalysis() (p. 797) Run the
AddTransientStructuralAnalysis
action.
Method AddTransientThermalAnalysis() (p. 797) Run the
AddTransientThermalAnalysis
action.
Method AddTreeGroupingFolder(IDataModelObject) (p. 797) Move the Data Model Object to a
new TreeGroupingFolder.
Method AddTreeGroupingFolder(IEnumerable) (p. 798) Move the Data Model Objects to a
new TreeGroupingFolder.
Method AddVirtualTopology() (p. 798) Creates a new VirtualTopology
Method AutoFilter() (p. 798) Enables interface filtering that only
displays model-level items
applicable to the particular analysis
type environments in which you
are working.
Method CenterOfMass() (p. 798) Calculates the center of mass of all
unsupressed bodies and point
masses.
Method ClearGeneratedData() (p. 799) Run the ClearGeneratedData action.
Method CreateCylindricalBolt(object, object, object, Create bolt with a cylinder head
object) (p. 799) based on the specified dimensions.
The bolt will be created so that the
base of the head is at the origin
and aligned with the Y-Z plane.
Valid input arguments include: 1)
`double` 2) `Quantity` 3) A string

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 779
Ansys.ACT.Automation.Mechanical Namespace

representation of `double` or
`Quantity`, i.e., "1.0" or "1.0 [cm]"
Method CreateCylindricalNut(object, object, object) (p. 799) Create a cylindrical nut with the
specified dimensions. The nut will
be created so that the base of the
nut is at the origin and aligned
with the Y-Z plane. Valid input
arguments include: 1) `double` 2)
`Quantity` 3) A string
representation of `double` or
`Quantity`, i.e., "1.0" or "1.0 [cm]"
Method CreateHexBolt(object, object, object, object) (p. 800) Create a bolt with a hex head
based on the specified dimensions.
The bolt will be created so that the
base of the head is at the origin
and aligned with the Y-Z plane.
Valid input arguments include: 1)
`double` 2) `Quantity` 3) A string
representation of `double` or
`Quantity`, i.e., "1.0" or "1.0 [cm]"
Method CreateHexNut(object, object, object) (p. 800) Create a hex nut with the specified
dimensions. The nut will be created
so that the base of the nut is at the
origin and aligned with the Y-Z
plane. Valid input arguments
include: 1) `double` 2) `Quantity`
3) A string representation of
`double` or `Quantity`, i.e., "1.0" or
"1.0 [cm]"
Method CreatePartInstance(IGeoPart) (p. 801) This will create an instance (not an
independent copy) of the provided
part. The use of instanced parts for
replication is highly recommended
for memory and performance
reasons.
Method DeleteParts(object) (p. 801) Deletes the provide parts if they
exist. Otherwise, nothing happens.
An exception will be issued if the
argument is invalid.
Method DisableFilter() (p. 801) Disables interface filtering so that
model-level items are not filtered
out based on the environment
types in your model.
Method EvaluateScriptDefinedResults() (p. 802) No details are provided for this
entry.
Method FreezeMeshOnSelectedParts(object) (p. 802) Run the
FreezeMeshOnSelectedParts action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
780 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by


IList<ChildrenType>) (p. 802) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 802) type.
Method GetFECommandsRepository(string, string) (p. 803) Gets the commands repository for
a file from external model.
Method GetResults() (p. 803) Gets the Results from the server.
Method GetTransformationOnPart(IGeoPart) (p. 803) Get the transformation matrix of
the provided part.
Method LoadResultFile(string) (p. 804) Creates a results-only system and
loads the result file.
Method RefreshMaterials() (p. 804) Run the RefresMaterials action.
Method SetTransformationOnPart(IGeoPart, Transform a part with given
RigidBodyTransformationMatrix) (p. 804) transformation. Only rigid body
transformation is supported, i.e., no
scaling will be performed. The
validity of “transformationMatrix”
will be checked against the
constraints of rigid body
transforms; an error will be emitted
if the matrix is ill-formed.
Method Solve(bool, SolveConfiguration) (p. 805) Run the Solve action.
Method Solve(bool, string) (p. 805) Run the Solve action.
Method UnfreezeMeshOnSelectedParts(object) (p. 805) Run the
UnfreezeMeshOnSelectedParts
action.
Method UpdateGeometryFromSource() (p. 806) Run the
UpdateGeometryFromSource
action.

AEDTImportManager
Get the manager for manipulating import settings for AEDT files.

Declaration Syntax
public AEDTImportManager AEDTImportManager { get; }

Ambient
Gets or sets the Ambient Lighting factor.

Declaration Syntax
public double Ambient { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 781
Ansys.ACT.Automation.Mechanical Namespace

AMProcess
Gets the AMProcess.

Declaration Syntax
public AMProcess AMProcess { get; }

Analyses
Gets the Analyses.

Declaration Syntax
public IList<Analysis> Analyses { get; }

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Color
Gets or sets the Lighting Color. Can also be set using Hex color codes; three byte hexadecimal numbers
(consisting of six digits) preceded by '0x', where each byte (or pair of characters in the Hex code)
represents the intensity of red, green and blue in the color respectively. For example, 0xFFFFFF.

Declaration Syntax
public int Color { set;get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
782 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CondensedGeometry
Gets the CondensedGeometry.

Declaration Syntax
public CondensedGeometry CondensedGeometry { get; }

Connections
Gets the Connections.

Declaration Syntax
public Connections Connections { get; }

ConstructionGeometry
Gets the ConstructionGeometry.

Declaration Syntax
public ConstructionGeometry ConstructionGeometry { get; }

Control
Gets the Control.

Declaration Syntax
public string Control { get; }

CoordinateSystems
Gets the CoordinateSystems.

Declaration Syntax
public CoordinateSystems CoordinateSystems { get; }

CrossSections
Gets the CrossSections.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 783
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CrossSections CrossSections { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Diffuse
Gets or sets the Diffuse Lighting factor.

Declaration Syntax
public double Diffuse { set;get; }

Environments ***OBSOLETE*** Use 'Analyses' property instead.


Gets the Analyses.

Declaration Syntax
public IEnumerable<Analysis> Environments { get; }

FeatureDetection
Gets the FeatureDetection.

Declaration Syntax
public FeatureDetection FeatureDetection { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Fracture
Gets the Fracture.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
784 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public Fracture Fracture { get; }

Geometry
Gets the Geometry.

Declaration Syntax
public Geometry Geometry { get; }

GeometryImportGroup
Gets the GeometryImportGroup.

Declaration Syntax
public GeometryImportGroup GeometryImportGroup { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSModelAuto InternalObject { get; }

Materials
Gets the Materials.

Declaration Syntax
public Materials Materials { get; }

Measures
Gets the Measures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 785
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Measures Measures { get; }

Mesh
Gets the Mesh.

Declaration Syntax
public Mesh Mesh { get; }

MeshEdit
Gets the MeshEdit.

Declaration Syntax
public MeshEdit MeshEdit { get; }

MeshNumbering
Gets the MeshNumbering.

Declaration Syntax
public MeshNumbering MeshNumbering { get; }

NamedSelections
Gets the NamedSelections.

Declaration Syntax
public NamedSelections NamedSelections { get; }

PartTransformGroup
Gets the PartTransformGroup.

Declaration Syntax
public PartTransformGroup PartTransformGroup { get; }

RemotePoints
Gets the RemotePoints.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
786 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public RemotePoints RemotePoints { get; }

Specular
Gets or sets the Specular Lighting factor.

Declaration Syntax
public double Specular { set;get; }

Symmetry
Gets the Symmetry.

Declaration Syntax
public Symmetry Symmetry { get; }

SystemCaption
Gets the SystemCaption.

Declaration Syntax
public string SystemCaption { get; }

TableGroup
Gets the TableGroup.

Declaration Syntax
public TableGroup TableGroup { get; }

VirtualTopology
Gets the VirtualTopology.

Declaration Syntax
public VirtualTopology VirtualTopology { get; }

AddAMProcess()
Creates a new AMProcess

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 787
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AMProcess AddAMProcess()

AddChart()
Creates a new child Chart.

Declaration Syntax
public virtual Chart AddChart()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCompositeFailureCriteria()
Creates a new Composite Failure Criteria object.

Declaration Syntax
public virtual CompositeFailureCriteria AddCompositeFailureCriteria()

AddCondensedGeometry()
Creates a new CondensedGeometry

Declaration Syntax
public virtual CondensedGeometry AddCondensedGeometry()

AddConnections()
Creates a new Connections

Declaration Syntax
public virtual Connections AddConnections()

AddConstructionGeometry()
Creates a new ConstructionGeometry

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
788 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public virtual ConstructionGeometry AddConstructionGeometry()

AddCoSimulationPin()
Creates a new CoSimulationPin

Declaration Syntax
public virtual CoSimulationPin AddCoSimulationPin()

AddCoupledFieldHarmonic()
Run the AddCoupledFieldHarmonic action.

Declaration Syntax
public virtual Analysis AddCoupledFieldHarmonic()

AddCoupledFieldModal()
Run the AddCoupledFieldModal action.

Declaration Syntax
public virtual Analysis AddCoupledFieldModal()

AddCoupledFieldStatic()
Run the AddCoupledFieldStatic action.

Declaration Syntax
public virtual Analysis AddCoupledFieldStatic()

AddCoupledFieldTransient()
Run the AddCoupledFieldTransient action.

Declaration Syntax
public virtual Analysis AddCoupledFieldTransient()

AddCrossSections()
Creates new CrossSections group.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 789
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual CrossSections AddCrossSections()

AddDesignAssessmentAnalysis()
Run the AddDesignAssessmentAnalysis action.

Declaration Syntax
public virtual Analysis AddDesignAssessmentAnalysis()

AddDesignLifeAnalysis()
Run the AddDesignLifeAnalysis action.

Declaration Syntax
public virtual Analysis AddDesignLifeAnalysis()

AddEigenvalueBucklingAnalysis()
Run the AddEigenvalueBucklingAnalysis action.

Declaration Syntax
public virtual Analysis AddEigenvalueBucklingAnalysis()

AddElectricAnalysis()
Run the AddElectricAnalysis action.

Declaration Syntax
public virtual Analysis AddElectricAnalysis()

AddExplicitDynamicsAnalysis()
Run the AddExplicitDynamicsAnalysis action.

Declaration Syntax
public virtual Analysis AddExplicitDynamicsAnalysis()

AddFatigueCombination()
Creates a new FatigueCombination

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
790 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public virtual FatigueCombination AddFatigueCombination()

AddFeatureDetection()
Creates a new FeatureDetection

Declaration Syntax
public virtual FeatureDetection AddFeatureDetection()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddForcedResponseAnalysis()
Run the AddForcedResponseAnalysis action.

Declaration Syntax
public virtual Analysis AddForcedResponseAnalysis()

AddFracture()
Creates a new Fracture

Declaration Syntax
public virtual Fracture AddFracture()

AddGeometryImportGroup()
Get the

GeometryImportGroup instance.

Declaration Syntax
public virtual GeometryImportGroup AddGeometryImportGroup()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 791
Ansys.ACT.Automation.Mechanical Namespace

AddHarmonicAcousticAnalysis()
Run the AddHarmonicAcousticAnalysis action.

Declaration Syntax
public virtual Analysis AddHarmonicAcousticAnalysis()

AddHarmonicResponseAnalysis()
Run the AddHarmonicResponseAnalysis action.

Declaration Syntax
public virtual Analysis AddHarmonicResponseAnalysis()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImagePlane()
Creates an ImagePlane and adds it as a child of this object.

Declaration Syntax
public virtual ImagePlane AddImagePlane()

AddLSDynaAnalysis()
Run the AddLSDynaAnalysis action.

Declaration Syntax
public virtual Analysis AddLSDynaAnalysis()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
792 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

AddLSDynaRestartAnalysis()
Run the AddLSDynaRestartAnalysis action.

Declaration Syntax
public virtual Analysis AddLSDynaRestartAnalysis()

AddMagnetostaticAnalysis()
Run the AddMagnetostaticAnalysis action.

Declaration Syntax
public virtual Analysis AddMagnetostaticAnalysis()

AddMeasures()
Creates a new Measures

Declaration Syntax
public virtual Measures AddMeasures()

AddMeshEdit()
Creates a new MeshEdit

Declaration Syntax
public virtual MeshEdit AddMeshEdit()

AddMeshNumbering()
Creates a new MeshNumbering

Declaration Syntax
public virtual MeshNumbering AddMeshNumbering()

AddModalAcousticAnalysis()
Run the AddModalAcousticAnalysis action.

Declaration Syntax
public virtual Analysis AddModalAcousticAnalysis()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 793
Ansys.ACT.Automation.Mechanical Namespace

AddModalAnalysis()
Run the AddModalAnalysis action.

Declaration Syntax
public virtual Analysis AddModalAnalysis()

AddMotionAnalysis()
Run the AddMotionAnalysis action.

Declaration Syntax
public virtual Analysis AddMotionAnalysis()

AddNamedSelection()
Creates a new child NamedSelection.

Declaration Syntax
public virtual NamedSelection AddNamedSelection()

AddNamedSelectionFromSelectedConnections()
Creates a new Named Selections (Components) for the selected connections.

Declaration Syntax
public virtual IList<NamedSelection> AddNamedSelectionFromSelectedConnections()

AddPartTransform()
Creates a new child PartTransform.

Declaration Syntax
public virtual PartTransform AddPartTransform()

AddPythonCodeEventBased()
Creates a new PythonCodeEventBased

Declaration Syntax
public virtual PythonCodeEventBased AddPythonCodeEventBased()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
794 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

AddPythonResult()
Creates a new PythonResult

Declaration Syntax
public virtual PythonResult AddPythonResult()

AddRandomVibrationAnalysis()
Run the AddRandomVibrationAnalysis action.

Declaration Syntax
public virtual Analysis AddRandomVibrationAnalysis()

AddRemotePoint()
Creates a new child RemotePoint.

Declaration Syntax
public virtual RemotePoint AddRemotePoint()

AddResponseSpectrumAnalysis()
Run the AddResponseSpectrumAnalysis action.

Declaration Syntax
public virtual Analysis AddResponseSpectrumAnalysis()

AddRigidDynamicsAnalysis()
Run the AddRigidDynamicsAnalysis action.

Declaration Syntax
public virtual Analysis AddRigidDynamicsAnalysis()

AddSolutionCombination()
Creates a new SolutionCombination

Declaration Syntax
public virtual SolutionCombination AddSolutionCombination()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 795
Ansys.ACT.Automation.Mechanical Namespace

AddStaticAcousticAnalysis()
Run the AddStaticAcousticAnalysis action.

Declaration Syntax
public virtual Analysis AddStaticAcousticAnalysis()

AddStaticStructuralAnalysis()
Run the AddStaticStructuralAnalysis action.

Declaration Syntax
public virtual Analysis AddStaticStructuralAnalysis()

AddSteadyStateThermalAnalysis()
Run the AddSteadyStateThermalAnalysis action.

Declaration Syntax
public virtual Analysis AddSteadyStateThermalAnalysis()

AddSubstructureGenerationAnalysis()
Run the AddSubstructureGenerationAnalysis action.

Declaration Syntax
public virtual Analysis AddSubstructureGenerationAnalysis()

AddSymmetry()
Creates a new Symmetry

Declaration Syntax
public virtual Symmetry AddSymmetry()

AddTableGroup(bool)
Get the

TableGroup instance.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
796 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public virtual TableGroup AddTableGroup(bool activate)

Parameters
activate(bool)

No details are provided for this entry.

AddThermalElectricAnalysis()
Run the AddThermalElectricAnalysis action.

Declaration Syntax
public virtual Analysis AddThermalElectricAnalysis()

AddTopologyOptimizationAnalysis()
Run the AddTopologyOptimizationAnalysis action.

Declaration Syntax
public virtual Analysis AddTopologyOptimizationAnalysis()

AddTransientStructuralAnalysis()
Run the AddTransientStructuralAnalysis action.

Declaration Syntax
public virtual Analysis AddTransientStructuralAnalysis()

AddTransientThermalAnalysis()
Run the AddTransientThermalAnalysis action.

Declaration Syntax
public virtual Analysis AddTransientThermalAnalysis()

AddTreeGroupingFolder(IDataModelObject)
Move the Data Model Object to a new TreeGroupingFolder.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 797
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual TreeGroupingFolder AddTreeGroupingFolder(IDataModelObject dataModelObject)

Parameters
dataModelObject(IDataModelObject)

Object to group

AddTreeGroupingFolder(IEnumerable)
Move the Data Model Objects to a new TreeGroupingFolder.

Declaration Syntax
public virtual TreeGroupingFolder AddTreeGroupingFolder(IEnumerable dataModelObjects)

Parameters
dataModelObjects(IEnumerable)

List of Data Model Objects, Ids, Tuples of Ids

AddVirtualTopology()
Creates a new VirtualTopology

Declaration Syntax
public virtual VirtualTopology AddVirtualTopology()

AutoFilter()
Enables interface filtering that only displays model-level items applicable to the particular analysis
type environments in which you are working.

Declaration Syntax
public virtual void AutoFilter()

CenterOfMass()
Calculates the center of mass of all unsupressed bodies and point masses.

Declaration Syntax
public virtual Quantity[] CenterOfMass()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
798 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateCylindricalBolt(object, object, object, object)


Create bolt with a cylinder head based on the specified dimensions. The bolt will be created so that
the base of the head is at the origin and aligned with the Y-Z plane. Valid input arguments include:
1) `double` 2) `Quantity` 3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Declaration Syntax
public virtual IGeoPart CreateCylindricalBolt(object headHeight, object headRadius, object shankLength,
object shankRadius)

Parameters
headHeight(object)

The height of bolt head.

headRadius(object)

The radius of the bolt head.

shankLength(object)

The length of the shank.

shankRadius(object)

The radius of the shank.

CreateCylindricalNut(object, object, object)


Create a cylindrical nut with the specified dimensions. The nut will be created so that the base of the
nut is at the origin and aligned with the Y-Z plane. Valid input arguments include: 1) `double` 2)
`Quantity` 3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Declaration Syntax
public virtual IGeoPart CreateCylindricalNut(object height, object innerRadius, object outerRadius)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 799
Ansys.ACT.Automation.Mechanical Namespace

Parameters
height(object)

The height of bolt head.

innerRadius(object)

The inner radius of the nut, i.e. the shank radius.

outerRadius(object)

The outer radius of the nut.

CreateHexBolt(object, object, object, object)


Create a bolt with a hex head based on the specified dimensions. The bolt will be created so that the
base of the head is at the origin and aligned with the Y-Z plane. Valid input arguments include: 1)
`double` 2) `Quantity` 3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Declaration Syntax
public virtual IGeoPart CreateHexBolt(object headHeight, object wrenchWidth, object shankLength,
object shankRadius)

Parameters
headHeight(object)

The height of bolt head.

wrenchWidth(object)

The width of the wrench fitting the bolt head.

shankLength(object)

The length of the shank.

shankRadius(object)

The radius of the shank.

CreateHexNut(object, object, object)


Create a hex nut with the specified dimensions. The nut will be created so that the base of the nut
is at the origin and aligned with the Y-Z plane. Valid input arguments include: 1) `double` 2) `Quantity`
3) A string representation of `double` or `Quantity`, i.e., "1.0" or "1.0 [cm]"

Declaration Syntax
public virtual IGeoPart CreateHexNut(object height, object innerRadius, object wrenchWidth)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
800 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Parameters
height(object)

The height of bolt head.

innerRadius(object)

The inner radius of the nut, i.e. the shank radius.

wrenchWidth(object)

The width of the wrench fitting the nut head.

CreatePartInstance(IGeoPart)
This will create an instance (not an independent copy) of the provided part. The use of instanced
parts for replication is highly recommended for memory and performance reasons.

Declaration Syntax
public virtual IGeoPart CreatePartInstance(IGeoPart part)

Parameters
part(IGeoPart)

The part to instance

DeleteParts(object)
Deletes the provide parts if they exist. Otherwise, nothing happens. An exception will be issued if the
argument is invalid.

Declaration Syntax
public virtual void DeleteParts(object parts)

Parameters
parts(object)

The parts to be deleted. It can be a single IGeoPart instance or an IEnumerable. If a collection is


provided, the presence of non-`IGeoPart` items will cause an exception to be issued.

DisableFilter()
Disables interface filtering so that model-level items are not filtered out based on the environment
types in your model.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 801
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void DisableFilter()

EvaluateScriptDefinedResults()
No details are provided for this entry.

Declaration Syntax
public virtual void EvaluateScriptDefinedResults()

FreezeMeshOnSelectedParts(object)
Run the FreezeMeshOnSelectedParts action.

Declaration Syntax
public virtual void FreezeMeshOnSelectedParts(object parts)

Parameters
parts(object)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
802 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetFECommandsRepository(string, string)
Gets the commands repository for a file from external model.

Declaration Syntax
public virtual CommandRepository GetFECommandsRepository(string source, string fileIdentifier)

Parameters
source(string)

Source (External Model) Component Id.

fileIdentifier(string)

File Identifier specified in the External Model.

GetResults()
Gets the Results from the server.

Declaration Syntax
public virtual void GetResults()

GetTransformationOnPart(IGeoPart)
Get the transformation matrix of the provided part.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 803
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual RigidBodyTransformationMatrix GetTransformationOnPart(IGeoPart part)

Parameters
part(IGeoPart)

The part of which the transformation is to be retrieved.

LoadResultFile(string)
Creates a results-only system and loads the result file.

Declaration Syntax
public virtual Solution LoadResultFile(string filePath)

Parameters
filePath(string)

The full path of the result file.

RefreshMaterials()
Run the RefresMaterials action.

Declaration Syntax
public virtual void RefreshMaterials()

SetTransformationOnPart(IGeoPart, RigidBodyTransformationMatrix)
Transform a part with given transformation. Only rigid body transformation is supported, i.e., no
scaling will be performed. The validity of “transformationMatrix” will be checked against the constraints
of rigid body transforms; an error will be emitted if the matrix is ill-formed.

Declaration Syntax
public virtual void SetTransformationOnPart(IGeoPart part, RigidBodyTransformationMatrix transform-
ationMatrix)

Parameters
part(IGeoPart)

The part to transform.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
804 of ANSYS, Inc. and its subsidiaries and affiliates.
Model

transformationMatrix(RigidBodyTransformationMatrix)

New transformation

Solve(bool, SolveConfiguration)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, SolveConfiguration config)

Parameters
wait(bool)

Wait or not for the solve to be done.

config(SolveConfiguration)

The solve configuration to use. If null, the default.

Solve(bool, string)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, string config)

Parameters
wait(bool)

Wait or not for the solve to be done.

config(string)

The solve configuration to use. Results in a new error message if the input solve configuration
does not exist. If none is provided, the default is used for the solve.

UnfreezeMeshOnSelectedParts(object)
Run the UnfreezeMeshOnSelectedParts action.

Declaration Syntax
public virtual void UnfreezeMeshOnSelectedParts(object parts)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 805
Ansys.ACT.Automation.Mechanical Namespace

Parameters
parts(object)

No details are provided for this entry.

UpdateGeometryFromSource()
Run the UpdateGeometryFromSource action.

Declaration Syntax
public virtual void UpdateGeometryFromSource()

ModelImport
Defines a ModelImport.

Declaration Syntax
public class ModelImport : DataModelObject, IRemovableDataModelObjectPreAction, IRemovableDataMod-
elObject, IRemovableDataModelObjectPostAction, IFolderDataModelObject

Table 283: Members

Property AnalysisTypeDimensionSetting (p. 807) Gets or sets the


AnalysisTypeDimensionSetting.
Property ApplicationSourceSetting (p. 808) Gets the ApplicationSourceSetting.
Property BodyGroupByAnsysElmTypeNumber (p. 808) Gets or sets the
BodyGroupByAnsysElmTypeNumber.
Property BodyGroupByMaterialNumber (p. 808) Gets or sets the
BodyGroupByMaterialNumber.
Property BodyGroupByThickness (p. 808) Gets or sets the BodyGroupByThickness.
Property Children (p. 808) Gets the list of children.
Property Comments (p. 808) Gets the list of associated comments.
Property CreateGeometry (p. 809) Gets or sets the CreateGeometry.
Property CreateGeometryEdgeComponents (p. 809) Gets or sets the
CreateGeometryEdgeComponents.
Property CreateGeometryFaceComponents (p. 809) Gets or sets the
CreateGeometryFaceComponents.
Property CreateGeometryVertexComponent (p. 809) Gets or sets the
CreateGeometryVertexComponent.
Property DataModelObjectCategory (p. 809) Gets the current DataModelObject's
category.
Property ElementComponentKey (p. 809) Gets or sets the ElementComponentKey.
Property ElementOffset (p. 810) Gets or sets the ElementOffset.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
806 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelImport

Property FaceComponentKey (p. 810) Gets or sets the FaceComponentKey.


Property Figures (p. 810) Gets the list of associated figures.
Property GeometryComponentKey (p. 810) Gets or sets the GeometryComponentKey.
Property Images (p. 810) Gets the list of associated images.
Property ImportMaterials (p. 810) Gets or sets the ImportMaterials.
Property InternalObject (p. 811) Gets the internal object. For advanced usage
only.
Property MaterialConsolidation (p. 811) Gets or sets the MaterialConsolidation.
Property ModelImportSourceFilePath (p. 811) Gets or sets the ModelImportSourceFilePath.
Property NodalComponentKey (p. 811) Gets or sets the NodalComponentKey.
Property NodeAndElementRenumberingMethod (p. 811) Gets or sets the
NodeAndElementRenumberingMethod.
Property NodeOffset (p. 811) Gets or sets the NodeOffset.
Property ProcessElementComponents (p. 812) Gets or sets the ProcessElementComponents.
Property ProcessFaceComponents (p. 812) Gets or sets the ProcessFaceComponents.
Property ProcessLineBodies (p. 812) Gets or sets the ProcessLineBodies.
Property ProcessMesh200Elms (p. 812) Gets or sets the ProcessMesh200Elms.
Property ProcessModelData (p. 812) Gets or sets the ProcessModelData.
Property ProcessNodalComponents (p. 812) Gets or sets the ProcessNodalComponents.
Property ProcessValidBlockedCDBFile (p. 813) Gets or sets the ProcessValidBlockedCDBFile.
Property SourceIdentifier (p. 813) Gets the SourceIdentifier.
Property ToleranceAngle (p. 813) Gets or sets the ToleranceAngle.
Property UnitSystemTypeForImport (p. 813) Gets or sets the UnitSystemTypeForImport.
Property VertexInsertionAngle (p. 813) Gets or sets the VertexInsertionAngle.
Method AddComment() (p. 813) Creates a new child Comment.
Method AddFigure() (p. 814) Creates a new child Figure.
Method AddImage(string) (p. 814) Creates a new child Image. If a filePath is
provided, the image will be loaded from that
file, if not, the image will be a screen capture
of the Geometry window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 814)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 814)

AnalysisTypeDimensionSetting
Gets or sets the AnalysisTypeDimensionSetting.

Declaration Syntax
public AnalysisTypeDimensionEnum AnalysisTypeDimensionSetting { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 807
Ansys.ACT.Automation.Mechanical Namespace

ApplicationSourceSetting
Gets the ApplicationSourceSetting.

Declaration Syntax
public ApplicationSourceEnum ApplicationSourceSetting { get; }

BodyGroupByAnsysElmTypeNumber
Gets or sets the BodyGroupByAnsysElmTypeNumber.

Declaration Syntax
public bool BodyGroupByAnsysElmTypeNumber { set;get; }

BodyGroupByMaterialNumber
Gets or sets the BodyGroupByMaterialNumber.

Declaration Syntax
public bool BodyGroupByMaterialNumber { set;get; }

BodyGroupByThickness
Gets or sets the BodyGroupByThickness.

Declaration Syntax
public bool BodyGroupByThickness { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
808 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelImport

CreateGeometry
Gets or sets the CreateGeometry.

Declaration Syntax
public bool CreateGeometry { set;get; }

CreateGeometryEdgeComponents
Gets or sets the CreateGeometryEdgeComponents.

Declaration Syntax
public bool CreateGeometryEdgeComponents { set;get; }

CreateGeometryFaceComponents
Gets or sets the CreateGeometryFaceComponents.

Declaration Syntax
public bool CreateGeometryFaceComponents { set;get; }

CreateGeometryVertexComponent
Gets or sets the CreateGeometryVertexComponent.

Declaration Syntax
public bool CreateGeometryVertexComponent { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ElementComponentKey
Gets or sets the ElementComponentKey.

Declaration Syntax
public string ElementComponentKey { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 809
Ansys.ACT.Automation.Mechanical Namespace

ElementOffset
Gets or sets the ElementOffset.

Declaration Syntax
public uint ElementOffset { set;get; }

FaceComponentKey
Gets or sets the FaceComponentKey.

Declaration Syntax
public string FaceComponentKey { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GeometryComponentKey
Gets or sets the GeometryComponentKey.

Declaration Syntax
public string GeometryComponentKey { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImportMaterials
Gets or sets the ImportMaterials.

Declaration Syntax
public bool ImportMaterials { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
810 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelImport

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSModelImportAuto InternalObject { get; }

MaterialConsolidation
Gets or sets the MaterialConsolidation.

Declaration Syntax
public bool MaterialConsolidation { set;get; }

ModelImportSourceFilePath
Gets or sets the ModelImportSourceFilePath.

Declaration Syntax
public string ModelImportSourceFilePath { set;get; }

NodalComponentKey
Gets or sets the NodalComponentKey.

Declaration Syntax
public string NodalComponentKey { set;get; }

NodeAndElementRenumberingMethod
Gets or sets the NodeAndElementRenumberingMethod.

Declaration Syntax
public NodeAndElementRenumberingMethodType NodeAndElementRenumberingMethod { set;get;
}

NodeOffset
Gets or sets the NodeOffset.

Declaration Syntax
public uint NodeOffset { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 811
Ansys.ACT.Automation.Mechanical Namespace

ProcessElementComponents
Gets or sets the ProcessElementComponents.

Declaration Syntax
public bool ProcessElementComponents { set;get; }

ProcessFaceComponents
Gets or sets the ProcessFaceComponents.

Declaration Syntax
public bool ProcessFaceComponents { set;get; }

ProcessLineBodies
Gets or sets the ProcessLineBodies.

Declaration Syntax
public bool ProcessLineBodies { set;get; }

ProcessMesh200Elms
Gets or sets the ProcessMesh200Elms.

Declaration Syntax
public bool ProcessMesh200Elms { set;get; }

ProcessModelData
Gets or sets the ProcessModelData.

Declaration Syntax
public bool ProcessModelData { set;get; }

ProcessNodalComponents
Gets or sets the ProcessNodalComponents.

Declaration Syntax
public bool ProcessNodalComponents { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
812 of ANSYS, Inc. and its subsidiaries and affiliates.
ModelImport

ProcessValidBlockedCDBFile
Gets or sets the ProcessValidBlockedCDBFile.

Declaration Syntax
public bool ProcessValidBlockedCDBFile { set;get; }

SourceIdentifier
Gets the SourceIdentifier.

Declaration Syntax
public string SourceIdentifier { get; }

ToleranceAngle
Gets or sets the ToleranceAngle.

Declaration Syntax
public Quantity ToleranceAngle { set;get; }

UnitSystemTypeForImport
Gets or sets the UnitSystemTypeForImport.

Declaration Syntax
public ModelImportUnitSystemType UnitSystemTypeForImport { set;get; }

VertexInsertionAngle
Gets or sets the VertexInsertionAngle.

Declaration Syntax
public Quantity VertexInsertionAngle { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 813
Ansys.ACT.Automation.Mechanical Namespace

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
814 of ANSYS, Inc. and its subsidiaries and affiliates.
MomentOfInertiaConstraint

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MomentOfInertiaConstraint
Defines a MomentOfInertiaConstraint.

Declaration Syntax
public class MomentOfInertiaConstraint : ResponseConstraint

Table 284: Members

Property Axis (p. 816) Gets or sets the Axis.


Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property CoordinateSystem (p. 816) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 816) Gets the current DataModelObject's category.
Property DefineBy (p. 816) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 816) Gets the internal object. For advanced usage only.
Property Location (p. 817) Gets or sets the Location.
Property MaximumValue (p. 817) Gets or sets the MaximumValue.
Property MinimumValue (p. 817) Gets or sets the MinimumValue.
Property PercentageToRetain (p. 817) Gets or sets the PercentageToRetain.
Property PercentageToRetainMax (p. 817) Gets or sets the PercentageToRetainMax.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 815
Ansys.ACT.Automation.Mechanical Namespace

Property PercentageToRetainMin (p. 817) Gets or sets the PercentageToRetainMin.


Property ScopingMethod (p. 818) Gets or sets the ScopingMethod.
Property Selection (p. 818) Gets or sets the Selection.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineBy
Gets or sets the DefineBy.

Declaration Syntax
public ResponseConstraintDefineBy DefineBy { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
816 of ANSYS, Inc. and its subsidiaries and affiliates.
MomentOfInertiaConstraint

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MaximumValue
Gets or sets the MaximumValue.

Declaration Syntax
public Quantity MaximumValue { set;get; }

MinimumValue
Gets or sets the MinimumValue.

Declaration Syntax
public Quantity MinimumValue { set;get; }

PercentageToRetain
Gets or sets the PercentageToRetain.

Declaration Syntax
public int PercentageToRetain { set;get; }

PercentageToRetainMax
Gets or sets the PercentageToRetainMax.

Declaration Syntax
public int PercentageToRetainMax { set;get; }

PercentageToRetainMin
Gets or sets the PercentageToRetainMin.

Declaration Syntax
public int PercentageToRetainMin { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 817
Ansys.ACT.Automation.Mechanical Namespace

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Selection
Gets or sets the Selection.

Declaration Syntax
public OptimizationRegion Selection { set;get; }

MorphingRegion
Defines a MorphingRegion.

Declaration Syntax
public class MorphingRegion : DataModelObject, IFolderDataModelObject

Table 285: Members

Property BaseFrequency (p. 819) Gets or sets the BaseFrequency.


Property Children (p. 819) Gets the list of children.
Property Comments (p. 819) Gets the list of associated comments.
Property DataModelObjectCategory (p. 819) Gets the current DataModelObject's category.
Property DisplayMesh (p. 820) Gets or sets the DisplayMesh.
Property Figures (p. 820) Gets the list of associated figures.
Property FixedLocation (p. 820) "FixedLocation" property defines the fixed faces of
the morphing region.
Property Images (p. 820) Gets the list of associated images.
Property InternalObject (p. 820) Gets the internal object. For advanced usage only.
Property MaximumFrequency (p. 820) Gets or sets the MaximumFrequency.
Property MinimumFrequency (p. 821) Gets or sets the MinimumFrequency.
Property MorphingFrequency (p. 821) Gets or sets the MorphingFrequency.
Property MorphingIntervals (p. 821) Gets or sets the MorphingIntervals.
Property MovingLocation (p. 821) "MovingLocation" property defines the moving
boundaries of the morphing region.
Property RegionLocation (p. 821) "RegionLocation" property defines the morphing
region bodies.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
818 of ANSYS, Inc. and its subsidiaries and affiliates.
MorphingRegion

Property SlidingLocation (p. 821) "SlidingLocation" property defines the sliding


constraints scoping.
Property Suppressed (p. 822) Gets or sets the Suppressed.
Property Thickness (p. 822) Gets or sets the Thickness .
Method AddComment() (p. 822) Creates a new child Comment.
Method AddFigure() (p. 822) Creates a new child Figure.
Method AddImage(string) (p. 822) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 823) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 823)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 823)

BaseFrequency
Gets or sets the BaseFrequency.

Declaration Syntax
public Quantity BaseFrequency { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 819
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DisplayMesh
Gets or sets the DisplayMesh.

Declaration Syntax
public bool DisplayMesh { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FixedLocation
"FixedLocation" property defines the fixed faces of the morphing region.

Declaration Syntax
public ISelectionInfo FixedLocation { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMorphingRegionAuto InternalObject { get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
820 of ANSYS, Inc. and its subsidiaries and affiliates.
MorphingRegion

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

MorphingFrequency
Gets or sets the MorphingFrequency.

Declaration Syntax
public Quantity MorphingFrequency { set;get; }

MorphingIntervals
Gets or sets the MorphingIntervals.

Declaration Syntax
public uint MorphingIntervals { set;get; }

MovingLocation
"MovingLocation" property defines the moving boundaries of the morphing region.

Declaration Syntax
public ISelectionInfo MovingLocation { set;get; }

RegionLocation
"RegionLocation" property defines the morphing region bodies.

Declaration Syntax
public ISelectionInfo RegionLocation { set;get; }

SlidingLocation
"SlidingLocation" property defines the sliding constraints scoping.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 821
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ISelectionInfo SlidingLocation { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Thickness
Gets or sets the Thickness .

Declaration Syntax
public Quantity Thickness { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
822 of ANSYS, Inc. and its subsidiaries and affiliates.
MorphingRegion

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 823
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

NamedSelection
Defines a NamedSelection.

Declaration Syntax
public class NamedSelection : ImportedDataModelObject, IMechanicalSelectionInfo, ISelectionInfo,
IFolderDataModelObject

Table 286: Members

Property Children (p. 825) Gets the list of children.


Property Comments (p. 825) Gets the list of associated comments.
Property CrackFrontNumber (p. 825) Gets the CrackFrontNumber.
Property CreatedForCrack (p. 826) Gets the CreatedForCrack.
Property DataModelObjectCategory (p. 826) Gets the current DataModelObject's
category.
Property Figures (p. 826) Gets the list of associated figures.
Property GenerationCriteria (p. 826) Returns the generation criteria that is used
to generate the selection.
Property Images (p. 826) Gets the list of associated images.
Property IncludeProgramControlledInflation (p. 826) Gets or sets the
IncludeProgramControlledInflation.
Property InternalObject (p. 827) Gets the internal object. For advanced
usage only.
Property Location (p. 827) Gets or sets the Location.
Property LSDynaUserId (p. 827) Gets or sets the LSDynaUserId.
Property PreserveDuringSolve (p. 827) Gets or sets the PreserveDuringSolve.
Property RelativeTolerance (p. 827) Gets or sets the RelativeTolerance.
Property ScopingMethod (p. 827) Gets or sets the ScopingMethod.
Property SendAs (p. 828) Gets or sets the SendAs.
Property SendToSolver (p. 828) Gets or sets the SendToSolver.
Property Suppressed (p. 828) Gets the Suppressed.
Property ToleranceType (p. 828) Gets or sets the ToleranceType.
Property TotalSelection (p. 828) Gets the TotalSelection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
824 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

Property Type (p. 828) Gets the Type.


Property UsedByMeshWorksheet (p. 829) Gets the UsedByMeshWorksheet.
Property Visible (p. 829) Gets or sets the Visible.
Property ZeroTolerance (p. 829) Gets or sets the ZeroTolerance.
Method AddComment() (p. 829) Creates a new child Comment.
Method AddFigure() (p. 829) Creates a new child Figure.
Method AddImage(string) (p. 829) Creates a new child Image. If a filePath is
provided, the image will be loaded from
that file, if not, the image will be a screen
capture of the Geometry window.
Method CreateNodalNamedSelection() (p. 830) Creates a new Named Selection object
containing all the nodes from the entities
in the current named selection .
Method Delete() (p. 830) Run the Delete action.
Method ExportNamedSelectionToCDBFile(string) (p. 830) Export Named Selection to CDB file
Method ExportToTextFile(string) (p. 830) Run the ExportToTextFile action.
Method Generate() (p. 831) Generates the selection based on the
generation criteria.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 831)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 831)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CrackFrontNumber
Gets the CrackFrontNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 825
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int CrackFrontNumber { get; }

CreatedForCrack
Gets the CreatedForCrack.

Declaration Syntax
public GenericCrack CreatedForCrack { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerationCriteria
Returns the generation criteria that is used to generate the selection.

Declaration Syntax
public NamedSelectionCriteria GenerationCriteria { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

IncludeProgramControlledInflation
Gets or sets the IncludeProgramControlledInflation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
826 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

Declaration Syntax
public bool IncludeProgramControlledInflation { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSComponentAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

LSDynaUserId
Gets or sets the LSDynaUserId.

Declaration Syntax
public int LSDynaUserId { set;get; }

PreserveDuringSolve
Gets or sets the PreserveDuringSolve.

Declaration Syntax
public bool PreserveDuringSolve { set;get; }

RelativeTolerance
Gets or sets the RelativeTolerance.

Declaration Syntax
public double RelativeTolerance { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 827
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SendAs
Gets or sets the SendAs.

Declaration Syntax
public SendAs SendAs { set;get; }

SendToSolver
Gets or sets the SendToSolver.

Declaration Syntax
public bool SendToSolver { set;get; }

Suppressed
Gets the Suppressed.

Declaration Syntax
public int Suppressed { get; }

ToleranceType
Gets or sets the ToleranceType.

Declaration Syntax
public ToleranceType ToleranceType { set;get; }

TotalSelection
Gets the TotalSelection.

Declaration Syntax
public int TotalSelection { get; }

Type
Gets the Type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
828 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

Declaration Syntax
public bool Type { get; }

UsedByMeshWorksheet
Gets the UsedByMeshWorksheet.

Declaration Syntax
public bool UsedByMeshWorksheet { get; }

Visible
Gets or sets the Visible.

Declaration Syntax
public bool Visible { set;get; }

ZeroTolerance
Gets or sets the ZeroTolerance.

Declaration Syntax
public double ZeroTolerance { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 829
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

CreateNodalNamedSelection()
Creates a new Named Selection object containing all the nodes from the entities in the current named
selection .

Declaration Syntax
public virtual NamedSelection CreateNodalNamedSelection()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ExportNamedSelectionToCDBFile(string)
Export Named Selection to CDB file

Declaration Syntax
public virtual void ExportNamedSelectionToCDBFile(string filepath)

Parameters
filepath(string)

No details are provided for this entry.

ExportToTextFile(string)
Run the ExportToTextFile action.

Declaration Syntax
public virtual void ExportToTextFile(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
830 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelection

Parameters
filePath(string)

No details are provided for this entry.

Generate()
Generates the selection based on the generation criteria.

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 831
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

NamedSelectionCriteria
A collection of named selection criteria.

Declaration Syntax
public class NamedSelectionCriteria : IList<NamedSelectionCriterion>, ICollection<NamedSelectionCri-
terion>, IEnumerable<NamedSelectionCriterion>, IEnumerable

Table 287: Members

Property Count (p. 832) The number of criteria in the collection.


Property Item (p. 832) The criterion at the given index.
Method Add(NamedSelectionCriterion) (p. 833) Adds the given criterion to the collection.
Method Clear() (p. 833) Clears the collection.
Method Contains(NamedSelectionCriterion) (p. 833) Returns whether the collection contains the
given criterion.
Method IndexOf(NamedSelectionCriterion) (p. 833) Returns the index of the given criterion if it
exists in the collection. Returns -1 if it does not
Method Insert(int, Inserts the given criterion into the collection at
NamedSelectionCriterion) (p. 834) the given index.
Method Remove(NamedSelectionCriterion) (p. 834) Removes the given criterion from the collection
if it exists in the collection. Throws an exception
if it does not.
Method RemoveAt(int) (p. 834) Removes the criterion at the given index. Throws
an exception if the given index is not valid.

Count
The number of criteria in the collection.

Declaration Syntax
public int Count { get; }

Item(int)
The criterion at the given index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
832 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelectionCriteria

Declaration Syntax
public NamedSelectionCriterion Item { set;get; }

Add(NamedSelectionCriterion)
Adds the given criterion to the collection.

Declaration Syntax
public virtual void Add(NamedSelectionCriterion criterion)

Parameters
criterion(NamedSelectionCriterion)

No details are provided for this entry.

Clear()
Clears the collection.

Declaration Syntax
public virtual void Clear()

Contains(NamedSelectionCriterion)
Returns whether the collection contains the given criterion.

Declaration Syntax
public virtual bool Contains(NamedSelectionCriterion criterion)

Parameters
criterion(NamedSelectionCriterion)

No details are provided for this entry.

IndexOf(NamedSelectionCriterion)
Returns the index of the given criterion if it exists in the collection. Returns -1 if it does not

Declaration Syntax
public virtual int IndexOf(NamedSelectionCriterion criterion)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 833
Ansys.ACT.Automation.Mechanical Namespace

Parameters
criterion(NamedSelectionCriterion)

No details are provided for this entry.

Insert(int, NamedSelectionCriterion)
Inserts the given criterion into the collection at the given index.

Declaration Syntax
public virtual void Insert(int index, NamedSelectionCriterion criterion)

Parameters
index(int)

No details are provided for this entry.

criterion(NamedSelectionCriterion)

No details are provided for this entry.

Remove(NamedSelectionCriterion)
Removes the given criterion from the collection if it exists in the collection. Throws an exception if
it does not.

Declaration Syntax
public virtual bool Remove(NamedSelectionCriterion criterion)

Parameters
criterion(NamedSelectionCriterion)

No details are provided for this entry.

RemoveAt(int)
Removes the criterion at the given index. Throws an exception if the given index is not valid.

Declaration Syntax
public virtual void RemoveAt(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
834 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelectionCriterion

Parameters
index(int)

No details are provided for this entry.

NamedSelectionCriterion
No details are provided for this entry.

Declaration Syntax
public class NamedSelectionCriterion

Table 288: Members

Constructor NamedSelectionCriterion(bool, Creates a new NamedSelectionCriterion


SelectionActionType, SelectionType, instance with the provided properties.
SelectionCriterionType,
SelectionOperatorType, object, Quantity,
Quantity, CoordinateSystem) (p. 835)
Property Action (p. 836) No details are provided for this entry.
Property Active (p. 836) No details are provided for this entry.
Property CoordinateSystem (p. 837) No details are provided for this entry.
Property Criterion (p. 837) No details are provided for this entry.
Property EntityType (p. 837) No details are provided for this entry.
Property LowerBound (p. 837) No details are provided for this entry.
Property Operator (p. 837) No details are provided for this entry.
Property UpperBound (p. 837) No details are provided for this entry.
Property Value (p. 838) No details are provided for this entry.

NamedSelectionCriterion(bool, SelectionActionType, SelectionType, Selec-


tionCriterionType, SelectionOperatorType, object, Quantity, Quantity, Co-
ordinateSystem)
Creates a new NamedSelectionCriterion instance with the provided properties.

Declaration Syntax
public NamedSelectionCriterion(bool active, SelectionActionType actionType, SelectionType entityType,
SelectionCriterionType criterionType, SelectionOperatorType operatorType, object value, Quantity
lowerBound, Quantity upperBound, CoordinateSystem coordinateSystem)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 835
Ansys.ACT.Automation.Mechanical Namespace

Parameters
active(bool)

No details are provided for this entry.

actionType(SelectionActionType)

No details are provided for this entry.

entityType(SelectionType)

No details are provided for this entry.

criterionType(SelectionCriterionType)

No details are provided for this entry.

operatorType(SelectionOperatorType)

No details are provided for this entry.

value(object)

No details are provided for this entry.

lowerBound(Quantity)

No details are provided for this entry.

upperBound(Quantity)

No details are provided for this entry.

coordinateSystem(CoordinateSystem)

No details are provided for this entry.

Action
No details are provided for this entry.

Declaration Syntax
public SelectionActionType Action { set;get; }

Active
No details are provided for this entry.

Declaration Syntax
public bool Active { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
836 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelectionCriterion

CoordinateSystem
No details are provided for this entry.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Criterion
No details are provided for this entry.

Declaration Syntax
public SelectionCriterionType Criterion { set;get; }

EntityType
No details are provided for this entry.

Declaration Syntax
public SelectionType EntityType { set;get; }

LowerBound
No details are provided for this entry.

Declaration Syntax
public object LowerBound { set;get; }

Operator
No details are provided for this entry.

Declaration Syntax
public SelectionOperatorType Operator { set;get; }

UpperBound
No details are provided for this entry.

Declaration Syntax
public object UpperBound { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 837
Ansys.ACT.Automation.Mechanical Namespace

Value
No details are provided for this entry.

Declaration Syntax
public object Value { set;get; }

NamedSelections
Defines a NamedSelections.

Declaration Syntax
public class NamedSelections : DataModelObject, IFolderDataModelObject

Table 289: Members

Property Children (p. 839) Gets the list of children.


Property Comments (p. 839) Gets the list of associated comments.
Property DataModelObjectCategory (p. 839) Gets the current DataModelObject's
category.
Property Figures (p. 839) Gets the list of associated figures.
Property GenerateOnRefresh (p. 839) Gets or sets the GenerateOnRefresh.
Property GenerateOnRemesh (p. 840) Gets or sets the GenerateOnRemesh.
Property Images (p. 840) Gets the list of associated images.
Property InternalObject (p. 840) Gets the internal object. For advanced
usage only.
Property RandomColors (p. 840) Gets the RandomColors.
Property ShowAnnotations (p. 840) Gets or sets the ShowAnnotations.
Method AddComment() (p. 840) Creates a new child Comment.
Method AddFigure() (p. 841) Creates a new child Figure.
Method AddImage(string) (p. 841) Creates a new child Image. If a filePath
is provided, the image will be loaded
from that file, if not, the image will be
a screen capture of the Geometry
window.
Method AddNamedSelection() (p. 841) Creates a new NamedSelection
Method Delete() (p. 841) Run the Delete action.
Method ExportNamedSelectionToCDBFile(string) (p. 841) Export Named Selections to CDB file
Method GenerateAllNamedSelections() (p. 842) Generate all named selections
specified with the Worksheet
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 842) type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
838 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelections

Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by


IList<IDataModelObject>) (p. 842) type.
Method GoToNamedSelectionsCommonToSelection() (p. 843) No details are provided for this entry.
Method GoToNamedSelectionsContainingSelection() (p. 843) No details are provided for this entry.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerateOnRefresh
Gets or sets the GenerateOnRefresh.

Declaration Syntax
public bool GenerateOnRefresh { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 839
Ansys.ACT.Automation.Mechanical Namespace

GenerateOnRemesh
Gets or sets the GenerateOnRemesh.

Declaration Syntax
public bool GenerateOnRemesh { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSComponentGroupAuto InternalObject { get; }

RandomColors
Gets the RandomColors.

Declaration Syntax
public bool RandomColors { get; }

ShowAnnotations
Gets or sets the ShowAnnotations.

Declaration Syntax
public bool ShowAnnotations { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
840 of ANSYS, Inc. and its subsidiaries and affiliates.
NamedSelections

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddNamedSelection()
Creates a new NamedSelection

Declaration Syntax
public virtual NamedSelection AddNamedSelection()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ExportNamedSelectionToCDBFile(string)
Export Named Selections to CDB file

Declaration Syntax
public virtual void ExportNamedSelectionToCDBFile(string filepath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 841
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filepath(string)

No details are provided for this entry.

GenerateAllNamedSelections()
Generate all named selections specified with the Worksheet

Declaration Syntax
public virtual void GenerateAllNamedSelections()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
842 of ANSYS, Inc. and its subsidiaries and affiliates.
NastranExportOptions

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GoToNamedSelectionsCommonToSelection()
No details are provided for this entry.

Declaration Syntax
public virtual void GoToNamedSelectionsCommonToSelection()

GoToNamedSelectionsContainingSelection()
No details are provided for this entry.

Declaration Syntax
public virtual void GoToNamedSelectionsContainingSelection()

NastranExportOptions
Defines the NastranExportOptions.

Declaration Syntax
public class NastranExportOptions : Dictionary<string, object>

Table 290: Members

Constructor NastranExportOptions(string, string, int, int, double, No details are provided for this
double, string, int, double, bool) (p. 844) entry.
Property AnalysisType (p. 845) Analysis type.
Property GridCS (p. 845) Grid coordinate system
number.
Property GroundCheck (p. 845) Ground check.
Property JointStiffness (p. 845) Joint stiffness.
Property Modes (p. 845) Modes.
Property NastranFilename (p. 845) Full path of Nastran export file.
Property Offset (p. 846) Offset.
Property PyramidElements (p. 846) Pyramid elements.
Property Time (p. 846) Time.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 843
Ansys.ACT.Automation.Mechanical Namespace

Property WTMass (p. 846) WTMass.

NastranExportOptions(string, string, int, int, double, double, string, int,


double, bool)
No details are provided for this entry.

Declaration Syntax
public NastranExportOptions(string NastranFilename, string AnalysisType, int GridCS, int Offset, double
WTMass, double JointStiffness, string PyramidElements, int Modes, double Time, bool GroundCheck)

Parameters
NastranFilename(string)

No details are provided for this entry.

AnalysisType(string)

No details are provided for this entry.

GridCS(int)

No details are provided for this entry.

Offset(int)

No details are provided for this entry.

WTMass(double)

No details are provided for this entry.

JointStiffness(double)

No details are provided for this entry.

PyramidElements(string)

No details are provided for this entry.

Modes(int)

No details are provided for this entry.

Time(double)

No details are provided for this entry.

GroundCheck(bool)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
844 of ANSYS, Inc. and its subsidiaries and affiliates.
NastranExportOptions

AnalysisType
Analysis type.

Declaration Syntax
public string AnalysisType { set;get; }

GridCS
Grid coordinate system number.

Declaration Syntax
public int GridCS { set;get; }

GroundCheck
Ground check.

Declaration Syntax
public bool GroundCheck { set;get; }

JointStiffness
Joint stiffness.

Declaration Syntax
public double JointStiffness { set;get; }

Modes
Modes.

Declaration Syntax
public int Modes { set;get; }

NastranFilename
Full path of Nastran export file.

Declaration Syntax
public string NastranFilename { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 845
Ansys.ACT.Automation.Mechanical Namespace

Offset
Offset.

Declaration Syntax
public int Offset { set;get; }

PyramidElements
Pyramid elements.

Declaration Syntax
public string PyramidElements { set;get; }

Time
Time.

Declaration Syntax
public double Time { set;get; }

WTMass
WTMass.

Declaration Syntax
public double WTMass { set;get; }

NaturalFrequencyConstraint
Defines a NaturalFrequencyConstraint.

Declaration Syntax
public class NaturalFrequencyConstraint : ResponseConstraint

Table 291: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 847)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
846 of ANSYS, Inc. and its subsidiaries and affiliates.
NaturalFrequencyConstraint

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 847) Gets the internal object. For advanced usage only.
Property MaximumFrequency (p. 847) Gets or sets the MaximumFrequency.
Property MinimumFrequency (p. 847) Gets or sets the MinimumFrequency.
Property ModeNumber (p. 847) Gets or sets the ModeNumber.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

ModeNumber
Gets or sets the ModeNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 847
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public uint ModeNumber { set;get; }

NodeMerge
Defines a NodeMerge.

Defines a NodeMerge.

Declaration Syntax
public class NodeMerge : DataModelObject, IFolderDataModelObject

Table 292: Members

Property Children (p. 849) Gets the list of children.


Property Comments (p. 849) Gets the list of associated comments.
Property DataModelObjectCategory (p. 849) Gets the current DataModelObject's category.
Property Figures (p. 849) Gets the list of associated figures.
Property Images (p. 849) Gets the list of associated images.
Property InternalObject (p. 849) Gets the internal object. For advanced usage only.
Property MasterBodies (p. 850) Gets the MasterBodies.
Property MasterLocation (p. 850) Gets or sets the MasterLocation.
Property ScopingMethod (p. 850) No details are provided for this entry.
Property SlaveBodies (p. 850) Gets the SlaveBodies.
Property SlaveLocation (p. 850) Gets or sets the SlaveLocation.
Property Suppressed (p. 850) Gets or sets the Suppressed.
Property ToleranceType (p. 851) Gets or sets the ToleranceType.
Property ToleranceValue (p. 851) Gets/ Sets the ToleranceValue.
Method AddComment() (p. 851) Creates a new child Comment.
Method AddFigure() (p. 851) Creates a new child Figure.
Method AddImage(string) (p. 851) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 852) Run the Delete action.
Method Generate() (p. 852) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 852)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 852)
Method RenameBasedOnDefinition() (p. 853) Run the RenameBasedOnDefinition action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
848 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMerge

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshConnectionAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 849
Ansys.ACT.Automation.Mechanical Namespace

MasterBodies
Gets the MasterBodies.

Declaration Syntax
public string MasterBodies { get; }

MasterLocation
Gets or sets the MasterLocation.

Declaration Syntax
public ISelectionInfo MasterLocation { set;get; }

ScopingMethod
No details are provided for this entry.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SlaveBodies
Gets the SlaveBodies.

Declaration Syntax
public string SlaveBodies { get; }

SlaveLocation
Gets or sets the SlaveLocation.

Declaration Syntax
public ISelectionInfo SlaveLocation { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
850 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMerge

ToleranceType
Gets or sets the ToleranceType.

Declaration Syntax
public ContactToleranceType ToleranceType { set;get; }

ToleranceValue
Gets/ Sets the ToleranceValue.

Declaration Syntax
public Quantity ToleranceValue { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 851
Ansys.ACT.Automation.Mechanical Namespace

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Generate()
Run the Generate action.

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
852 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMergeGroup

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

NodeMergeGroup
Defines a NodeMergeGroup.

Declaration Syntax
public class NodeMergeGroup : ConnectionGroup

Table 293: Members

Property ActiveConnections (p. 3562) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 3560).)


Property AutomaticFixedJoints (p. 3562) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 3560).)


Property Children (p. 3562) Gets the list of children.

(Inherited from ConnectionGroup (p. 3560).)


Property Comments (p. 3562) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 3560).)


Property Connections (p. 3563) Gets the Connections.

(Inherited from ConnectionGroup (p. 3560).)


Property ConnectionType (p. 3563) Gets or sets the ConnectionType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 853
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 3560).)


Property CylindricalFaces (p. 3563) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 3560).)


Property DataModelObjectCategory (p. 855) Gets the current DataModelObject's category.
Property EdgeEdge (p. 3563) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 3560).)


Property EdgeOverlapTolerance (p. 3563) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceAngleTolerance (p. 3564) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceEdge (p. 3564) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceFace (p. 3564) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceFaceDetectionAngleTolerence (p. 3564)Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 3560).)


Property FaceOverlapTolerance (p. 3564) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 3560).)


Property Figures (p. 3564) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 3560).)


Property GroupBy (p. 3565) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 3560).)


Property Images (p. 3565) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 3560).)


Property InternalObject (p. 855) Gets the internal object. For advanced usage
only.
Property Location (p. 3565) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 3560).)


Property MinimumDistancePercentage (p. 3565) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 3560).)


Property MinimumDistanceValue (p. 3565) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 3560).)


Property Priority (p. 3566) Gets or sets the Priority.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
854 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMergeGroup

(Inherited from ConnectionGroup (p. 3560).)


Property RevoluteJoints (p. 3566) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 3560).)


Property SearchAcross (p. 3566) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 3560).)


Property Suppressed (p. 3566) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 3560).)


Property ThicknessScaleFactor (p. 3566) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceSlider (p. 3566) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceType (p. 3567) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 3560).)


Property ToleranceValue (p. 3567) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 3560).)


Property UseRange (p. 3567) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 3560).)


Method AddNodeMerge() (p. 855) Creates a new NodeMerge
Method GenerateNodeMerge() (p. 856) Generate mesh connections for the selected
mesh connection objects or groups in the model.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSConnectionGroupAuto InternalObject { get; }

AddNodeMerge()
Creates a new NodeMerge

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 855
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual NodeMerge AddNodeMerge()

GenerateNodeMerge()
Generate mesh connections for the selected mesh connection objects or groups in the model.

Declaration Syntax
public virtual void GenerateNodeMerge()

NodeMove
Defines a NodeMove.

Declaration Syntax
public class NodeMove : ImportedDataModelObject, IReadOnlyList<NodeMoveEntry>, IReadOnlyCollec-
tion<NodeMoveEntry>, IEnumerable<NodeMoveEntry>, IEnumerable, IFolderDataModelObject

Table 294: Members

Property Children (p. 857) Gets the list of children.


Property Comments (p. 857) Gets the list of associated comments.
Property DataModelObjectCategory (p. 857) Gets the current DataModelObject's category.
Property Figures (p. 857) Gets the list of associated figures.
Property Images (p. 857) Gets the list of associated images.
Property Information (p. 858) Gets the Information.
Property InternalObject (p. 858) Gets the internal object. For advanced usage only.
Property NumberOfMoves (p. 858) Gets the NumberOfMoves.
Property NumberOfNodes (p. 858) Gets the NumberOfNodes.
Method AddComment() (p. 858) Creates a new child Comment.
Method AddFigure() (p. 858) Creates a new child Figure.
Method AddImage(string) (p. 859) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 859) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 859)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 859)
Method MorphNodes() (p. 860) Morph all the nodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
856 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMove

Method MoveNode(int, Quantity, Quantity, Moves a node to a new specified location. The
Quantity) (p. 860) given locX, locY, and locZ values will be converted
to the unit system the mesh is stored in, and the
given node will be moved to that absolute location.
Method UndoAllNodeMoves() (p. 861) Undos all moves done to a node.
Method UndoLastNodeMove() (p. 861) Undos the last move done to a node.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 857
Ansys.ACT.Automation.Mechanical Namespace

Information
Gets the Information.

Declaration Syntax
public NodeMoveInformationType Information { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSNodeMoveAuto InternalObject { get; }

NumberOfMoves
Gets the NumberOfMoves.

Declaration Syntax
public uint NumberOfMoves { get; }

NumberOfNodes
Gets the NumberOfNodes.

Declaration Syntax
public uint NumberOfNodes { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
858 of ANSYS, Inc. and its subsidiaries and affiliates.
NodeMove

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 859
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MorphNodes()
Morph all the nodes.

Declaration Syntax
public virtual void MorphNodes()

MoveNode(int, Quantity, Quantity, Quantity)


Moves a node to a new specified location. The given locX, locY, and locZ values will be converted to
the unit system the mesh is stored in, and the given node will be moved to that absolute location.

Declaration Syntax
public virtual void MoveNode(int nodeId, Quantity locX, Quantity locY, Quantity locZ)

Parameters
nodeId(int)

The id of the node to be moved

locX(Quantity)

New X location

locY(Quantity)

New Y location

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
860 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberingControl

locZ(Quantity)

New Z location

UndoAllNodeMoves()
Undos all moves done to a node.

Declaration Syntax
public virtual void UndoAllNodeMoves()

UndoLastNodeMove()
Undos the last move done to a node.

Declaration Syntax
public virtual void UndoLastNodeMove()

NumberingControl
Defines a NumberingControl.

Declaration Syntax
public class NumberingControl : DataModelObject, IFolderDataModelObject

Table 295: Members

Property BeginElementNumber (p. 862) Gets or sets the BeginElementNumber.


Property BeginNodeNumber (p. 862) Gets or sets the BeginNodeNumber.
Property Children (p. 862) Gets the list of children.
Property Comments (p. 862) Gets the list of associated comments.
Property DataModelObjectCategory (p. 862) Gets the current DataModelObject's category.
Property EndElementNumber (p. 863) Gets or sets the EndElementNumber.
Property EndNodeNumber (p. 863) Gets or sets the EndNodeNumber.
Property Figures (p. 863) Gets the list of associated figures.
Property Images (p. 863) Gets the list of associated images.
Property InternalObject (p. 863) Gets the internal object. For advanced usage only.
Property Location (p. 863) Gets or sets the Location.
Property NodeNumber (p. 864) Gets or sets the NodeNumber.
Property Suppressed (p. 864) Gets or sets the Suppressed.
Method AddComment() (p. 864) Creates a new child Comment.
Method AddFigure() (p. 864) Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 861
Ansys.ACT.Automation.Mechanical Namespace

Method AddImage(string) (p. 864) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 865) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 865)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 865)

BeginElementNumber
Gets or sets the BeginElementNumber.

Declaration Syntax
public uint BeginElementNumber { set;get; }

BeginNodeNumber
Gets or sets the BeginNodeNumber.

Declaration Syntax
public uint BeginNodeNumber { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
862 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberingControl

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EndElementNumber
Gets or sets the EndElementNumber.

Declaration Syntax
public uint EndElementNumber { set;get; }

EndNodeNumber
Gets or sets the EndNodeNumber.

Declaration Syntax
public uint EndNodeNumber { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshRenumberingControlAuto InternalObject { get; }

Location
Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 863
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ISelectionInfo Location { set;get; }

NodeNumber
Gets or sets the NodeNumber.

Declaration Syntax
public uint NodeNumber { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
864 of ANSYS, Inc. and its subsidiaries and affiliates.
NumberingControl

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 865
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Objective
Defines a Objective.

Declaration Syntax
public class Objective : DataModelObject, IFolderDataModelObject

Table 296: Members

Property Children (p. 866) Gets the list of children.


Property Comments (p. 867) Gets the list of associated comments.
Property DataModelObjectCategory (p. 867) Gets the current DataModelObject's category.
Property Images (p. 867) Gets the list of associated images.
Property InternalObject (p. 867) Gets the internal object. For advanced usage only.
Property NormalizedSum (p. 867) Gets or sets the NormalizedSum.
Property Suppressed (p. 867) Gets or sets the Suppressed.
Property Worksheet (p. 868) Get the ObjectiveWorksheet action.
Method AddComment() (p. 868) Creates a new child Comment.
Method AddImage(string) (p. 868) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 868) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 868)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 869)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
866 of ANSYS, Inc. and its subsidiaries and affiliates.
Objective

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoObjectiveAuto InternalObject { get; }

NormalizedSum
Gets or sets the NormalizedSum.

Declaration Syntax
public bool NormalizedSum { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 867
Ansys.ACT.Automation.Mechanical Namespace

Worksheet
Get the ObjectiveWorksheet action.

Declaration Syntax
public ObjectiveWorksheet Worksheet { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
868 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ObjectiveWorksheet
No details are provided for this entry.

Declaration Syntax
public class ObjectiveWorksheet : Worksheet

Table 297: Members

Property RowCount (p. 870) Deletes a row from the worksheet at index.
Method AddRow() (p. 871) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 871) Deletes a row from the worksheet at index.
Method GetCriterion(int) (p. 871) Gets the worksheet Environment property at
index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 869
Ansys.ACT.Automation.Mechanical Namespace

Method GetEnabled(int) (p. 871) Gets the worksheet Enabled property at row
index
Method GetEndMode(int) (p. 872) Gets the worksheet End Mode property at index.
Method GetEndStep(int) (p. 872) Gets the worksheet End Step property at index.
Method GetEnvironment(int) (p. 872) Gets the worksheet Environment property at
index.
Method GetFormulation(int) (p. 872) Gets the worksheet Formulation property at
index.
Method GetMode(int) (p. 873) Gets the worksheet Mode property at index.
Method GetMultipleSets(int) (p. 873) Gets the worksheet Multiple Sets property at row
index
Method GetObjectiveType(int) (p. 873) Gets the Objective Type property at index.
Method GetStartMode(int) (p. 874) Gets the worksheet Start Mode property at index.
Method GetStartStep(int) (p. 874) Gets the worksheet Start Step property at index.
Method GetStep(int) (p. 874) Gets the worksheet Step property at index.
Method GetWeight(int) (p. 874) Gets the worksheet Weight property at index.
Method SetCriterion(int, Criterion) (p. 875) Sets the worksheet Environment property at
index.
Method SetEnabled(int, bool) (p. 875) Sets the worksheet Enabled property at row
index.
Method SetEndMode(int, int) (p. 875) Sets the worksheet End Mode property at index.
Method SetEndStep(int, int) (p. 876) Sets the worksheet End Step property at index.
Method SetEnvironment(int, Analysis) (p. 876) Sets the worksheet Environment property at
index.
Method SetFormulation(int, Sets the worksheet Formulation property at
TopoObjectiveFormulation) (p. 876) index.
Method SetMode(int, int) (p. 877) Sets the worksheet Mode property at index.
Method SetMultipleSets(int, bool) (p. 877) Sets the worksheet Multiple Sets property at row
index.
Method SetObjectiveType(int, Sets the ObjectiveType property at index.
ObjectiveType) (p. 878)
Method SetStartMode(int, int) (p. 878) Sets the worksheet Start Mode property at index.
Method SetStartStep(int, int) (p. 878) Sets the worksheet Start Step property at index.
Method SetStep(int, int) (p. 879) Sets the worksheet Step property at index.
Method SetWeight(int, double) (p. 879) Sets the worksheet Weight property at index.

RowCount
Deletes a row from the worksheet at index.

Declaration Syntax
public int RowCount { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
870 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

AddRow()
Adds a Row to the worksheet.

Declaration Syntax
public override int AddRow()

DeleteRow(int)
Deletes a row from the worksheet at index.

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)

No details are provided for this entry.

GetCriterion(int)
Gets the worksheet Environment property at index.

Declaration Syntax
public Criterion GetCriterion(int index)

Parameters
index(int)

No details are provided for this entry.

GetEnabled(int)
Gets the worksheet Enabled property at row index

Declaration Syntax
public bool GetEnabled(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 871
Ansys.ACT.Automation.Mechanical Namespace

GetEndMode(int)
Gets the worksheet End Mode property at index.

Declaration Syntax
public int GetEndMode(int index)

Parameters
index(int)

No details are provided for this entry.

GetEndStep(int)
Gets the worksheet End Step property at index.

Declaration Syntax
public int GetEndStep(int index)

Parameters
index(int)

No details are provided for this entry.

GetEnvironment(int)
Gets the worksheet Environment property at index.

Declaration Syntax
public Analysis GetEnvironment(int index)

Parameters
index(int)

No details are provided for this entry.

GetFormulation(int)
Gets the worksheet Formulation property at index.

Declaration Syntax
public TopoObjectiveFormulation GetFormulation(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
872 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Parameters
index(int)

No details are provided for this entry.

GetMode(int)
Gets the worksheet Mode property at index.

Declaration Syntax
public int GetMode(int index)

Parameters
index(int)

No details are provided for this entry.

GetMultipleSets(int)
Gets the worksheet Multiple Sets property at row index

Declaration Syntax
public bool GetMultipleSets(int index)

Parameters
index(int)

No details are provided for this entry.

GetObjectiveType(int)
Gets the Objective Type property at index.

Declaration Syntax
public ObjectiveType GetObjectiveType(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 873
Ansys.ACT.Automation.Mechanical Namespace

GetStartMode(int)
Gets the worksheet Start Mode property at index.

Declaration Syntax
public int GetStartMode(int index)

Parameters
index(int)

No details are provided for this entry.

GetStartStep(int)
Gets the worksheet Start Step property at index.

Declaration Syntax
public int GetStartStep(int index)

Parameters
index(int)

No details are provided for this entry.

GetStep(int)
Gets the worksheet Step property at index.

Declaration Syntax
public int GetStep(int index)

Parameters
index(int)

No details are provided for this entry.

GetWeight(int)
Gets the worksheet Weight property at index.

Declaration Syntax
public double GetWeight(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
874 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Parameters
index(int)

No details are provided for this entry.

SetCriterion(int, Criterion)
Sets the worksheet Environment property at index.

Declaration Syntax
public void SetCriterion(int index, Criterion newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(Criterion)

No details are provided for this entry.

SetEnabled(int, bool)
Sets the worksheet Enabled property at row index.

Declaration Syntax
public void SetEnabled(int index, bool value)

Parameters
index(int)

No details are provided for this entry.

value(bool)

No details are provided for this entry.

SetEndMode(int, int)
Sets the worksheet End Mode property at index.

Declaration Syntax
public void SetEndMode(int index, int newVal)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 875
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

No details are provided for this entry.

newVal(int)

No details are provided for this entry.

SetEndStep(int, int)
Sets the worksheet End Step property at index.

Declaration Syntax
public void SetEndStep(int index, int newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(int)

No details are provided for this entry.

SetEnvironment(int, Analysis)
Sets the worksheet Environment property at index.

Declaration Syntax
public void SetEnvironment(int index, Analysis newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(Analysis)

No details are provided for this entry.

SetFormulation(int, TopoObjectiveFormulation)
Sets the worksheet Formulation property at index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
876 of ANSYS, Inc. and its subsidiaries and affiliates.
ObjectiveWorksheet

Declaration Syntax
public void SetFormulation(int index, TopoObjectiveFormulation value)

Parameters
index(int)

No details are provided for this entry.

value(TopoObjectiveFormulation)

No details are provided for this entry.

SetMode(int, int)
Sets the worksheet Mode property at index.

Declaration Syntax
public void SetMode(int index, int newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(int)

No details are provided for this entry.

SetMultipleSets(int, bool)
Sets the worksheet Multiple Sets property at row index.

Declaration Syntax
public void SetMultipleSets(int index, bool value)

Parameters
index(int)

No details are provided for this entry.

value(bool)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 877
Ansys.ACT.Automation.Mechanical Namespace

SetObjectiveType(int, ObjectiveType)
Sets the ObjectiveType property at index.

Declaration Syntax
public void SetObjectiveType(int index, ObjectiveType value)

Parameters
index(int)

No details are provided for this entry.

value(ObjectiveType)

No details are provided for this entry.

SetStartMode(int, int)
Sets the worksheet Start Mode property at index.

Declaration Syntax
public void SetStartMode(int index, int newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(int)

No details are provided for this entry.

SetStartStep(int, int)
Sets the worksheet Start Step property at index.

Declaration Syntax
public void SetStartStep(int index, int newVal)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
878 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationMaterial

newVal(int)

No details are provided for this entry.

SetStep(int, int)
Sets the worksheet Step property at index.

Declaration Syntax
public void SetStep(int index, int newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(int)

No details are provided for this entry.

SetWeight(int, double)
Sets the worksheet Weight property at index.

Declaration Syntax
public void SetWeight(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(double)

No details are provided for this entry.

OptimizationMaterial
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 879
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class OptimizationMaterial

Table 298: Members

Property DensityMaximum (p. 880) Gets or sets the maximum density of the lattice for the
OptimizationMaterial (between 0 and 1)
Property DensityMinimum (p. 880) Gets or sets the minimum density of the lattice for the
OptimizationMaterial (between 0 and 1)
Property LatticeType (p. 880) Gets or sets the lattice shape for the OptimizationMaterial
Property Material (p. 880) Gets or sets the material it is based on (a Material, a string
or an objectId can be used to set it)
Property VolumeFillingMethod (p. 881) Gets or sets if the filling method for the OptimizationMaterial

DensityMaximum
Gets or sets the maximum density of the lattice for the OptimizationMaterial (between 0 and 1)

Declaration Syntax
public double DensityMaximum { set;get; }

DensityMinimum
Gets or sets the minimum density of the lattice for the OptimizationMaterial (between 0 and 1)

Declaration Syntax
public double DensityMinimum { set;get; }

LatticeType
Gets or sets the lattice shape for the OptimizationMaterial

Declaration Syntax
public LatticeType LatticeType { set;get; }

Material
Gets or sets the material it is based on (a Material, a string or an objectId can be used to set it)

Declaration Syntax
public object Material { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
880 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegion

VolumeFillingMethod
Gets or sets if the filling method for the OptimizationMaterial

Declaration Syntax
public FillingMethod VolumeFillingMethod { set;get; }

OptimizationRegion
Defines a OptimizationRegion.

Declaration Syntax
public class OptimizationRegion : OptimizationRegionBaseClass, IMechanicalSelectionInfo, ISelectionInfo

Table 299: Members

Property BoundaryCondition (p. 882) Gets or sets the BoundaryCondition.


Property Children (p. 887) Gets the list of children.

(Inherited from
OptimizationRegionBaseClass (p. 886).)
Property DataModelObjectCategory (p. 882) Gets the current DataModelObject's
category.
Property DesignRegionLocation (p. 883) Gets or sets the DesignRegionLocation.
Property ExclusionExtension (p. 883) Gets or sets the ExclusionExtension.
Property ExclusionRegionLocation (p. 887) Gets or sets the ExclusionRegionLocation.

(Inherited from
OptimizationRegionBaseClass (p. 886).)
Property ExclusionScopingMethod (p. 887) Gets or sets the
ExclusionScopingMethod.

(Inherited from
OptimizationRegionBaseClass (p. 886).)
Property ExclusionThickness (p. 883) Gets or sets the ExclusionThickness.
Property HyperbolicProjection (p. 883) Gets or sets the HyperbolicProjection.
Property InitializationHoleSize (p. 883) Gets or sets the InitializationHoleSize.
Property InitializationModifierType (p. 883) Gets or sets the
InitializationModifierType.
Property InitialVolumeFraction (p. 884) Gets or sets the InitialVolumeFraction.
Property InternalObject (p. 884) Gets the internal object. For advanced
usage only.
Property LatticeMaxDensity (p. 884) Gets or sets the LatticeMaxDensity.
Property LatticeMinDensity (p. 884) Gets or sets the LatticeMinDensity.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 881
Ansys.ACT.Automation.Mechanical Namespace

Property LatticeSize (p. 884) Gets or sets the LatticeSize.


Property LatticeType (p. 884) Gets or sets the LatticeType.
Property MaxCumulatedDisplacementControl (p. 887) Gets or sets the
MaxCumulatedDisplacementControl.

(Inherited from
OptimizationRegionBaseClass (p. 886).)
Property MeshDeformationToleranceControl (p. 885) Gets or sets the
MeshDeformationToleranceControl.
Property MorphingIterationMoveLimit (p. 885) Gets or sets the
MorphingIterationMoveLimit.
Property MorphingTotalMeshDeformationTolerance (p. 885) Gets or sets the
MorphingTotalMeshDeformationTolerance.
Property MorphingTotalMoveLimit (p. 887) Gets or sets the
MorphingTotalMoveLimit.

(Inherited from
OptimizationRegionBaseClass (p. 886).)
Property OptimizationType (p. 885) Gets or sets the OptimizationType.
Property PenaltyFactor (p. 885) Gets or sets the PenaltyFactor.
Property ShapeMoveLimitControl (p. 885) Gets or sets the ShapeMoveLimitControl.
Method AddExclusionRegion() (p. 886) Creates a new ExclusionRegion
Method GetDefinition() (p. 886) Gets the Worksheet Definition. This
Definition is a list of
OptimizationMaterial.
Method RenameBasedOnDefinition() (p. 886) Run the RenameBasedOnDefinition
action.

BoundaryCondition
Gets or sets the BoundaryCondition.

Declaration Syntax
public BoundaryConditionType BoundaryCondition { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
882 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegion

DesignRegionLocation
Gets or sets the DesignRegionLocation.

Declaration Syntax
public ISelectionInfo DesignRegionLocation { set;get; }

ExclusionExtension
Gets or sets the ExclusionExtension.

Declaration Syntax
public ExclusionType ExclusionExtension { set;get; }

ExclusionThickness
Gets or sets the ExclusionThickness.

Declaration Syntax
public Quantity ExclusionThickness { set;get; }

HyperbolicProjection
Gets or sets the HyperbolicProjection.

Declaration Syntax
public HyperbolicProjectionType HyperbolicProjection { set;get; }

InitializationHoleSize
Gets or sets the InitializationHoleSize.

Declaration Syntax
public Quantity InitializationHoleSize { set;get; }

InitializationModifierType
Gets or sets the InitializationModifierType.

Declaration Syntax
public InitializationModifierType InitializationModifierType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 883
Ansys.ACT.Automation.Mechanical Namespace

InitialVolumeFraction
Gets or sets the InitialVolumeFraction.

Declaration Syntax
public double InitialVolumeFraction { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSOptimizationRegionAuto InternalObject { get; }

LatticeMaxDensity
Gets or sets the LatticeMaxDensity.

Declaration Syntax
public double LatticeMaxDensity { set;get; }

LatticeMinDensity
Gets or sets the LatticeMinDensity.

Declaration Syntax
public double LatticeMinDensity { set;get; }

LatticeSize
Gets or sets the LatticeSize.

Declaration Syntax
public Quantity LatticeSize { set;get; }

LatticeType
Gets or sets the LatticeType.

Declaration Syntax
public LatticeType LatticeType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
884 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegion

MeshDeformationToleranceControl
Gets or sets the MeshDeformationToleranceControl.

Declaration Syntax
public TopoPropertyControlType MeshDeformationToleranceControl { set;get; }

MorphingIterationMoveLimit
Gets or sets the MorphingIterationMoveLimit.

Declaration Syntax
public double MorphingIterationMoveLimit { set;get; }

MorphingTotalMeshDeformationTolerance
Gets or sets the MorphingTotalMeshDeformationTolerance.

Declaration Syntax
public double MorphingTotalMeshDeformationTolerance { set;get; }

OptimizationType
Gets or sets the OptimizationType.

Declaration Syntax
public OptimizationType OptimizationType { set;get; }

PenaltyFactor
Gets or sets the PenaltyFactor.

Declaration Syntax
public double PenaltyFactor { set;get; }

ShapeMoveLimitControl
Gets or sets the ShapeMoveLimitControl.

Declaration Syntax
public TopoPropertyControlType ShapeMoveLimitControl { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 885
Ansys.ACT.Automation.Mechanical Namespace

AddExclusionRegion()
Creates a new ExclusionRegion

Declaration Syntax
public virtual ExclusionRegion AddExclusionRegion()

GetDefinition()
Gets the Worksheet Definition. This Definition is a list of OptimizationMaterial.

Declaration Syntax
public virtual MaterialsOptimizationDefinition GetDefinition()

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

OptimizationRegionBaseClass
Defines a OptimizationRegionBaseClass.

Declaration Syntax
public abstract class OptimizationRegionBaseClass : DataModelObject

Table 300: Members

Property Children (p. 887) Gets the list of children.


Property ExclusionRegionLocation (p. 887) Gets or sets the ExclusionRegionLocation.
Property ExclusionScopingMethod (p. 887) Gets or sets the ExclusionScopingMethod.
Property InternalObject (p. 887) Gets the internal object. For advanced usage
only.
Property MaxCumulatedDisplacementControl (p. 887) Gets or sets the
MaxCumulatedDisplacementControl.
Property MorphingTotalMoveLimit (p. 887) Gets or sets the MorphingTotalMoveLimit.
Method Delete() (p. 888) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 888)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
886 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegionBaseClass

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 888)

Children
Gets the list of children.

Declaration Syntax
public IList<DataModelObject> Children { get; }

ExclusionRegionLocation
Gets or sets the ExclusionRegionLocation.

Declaration Syntax
public ISelectionInfo ExclusionRegionLocation { set;get; }

ExclusionScopingMethod
Gets or sets the ExclusionScopingMethod.

Declaration Syntax
public GeometryDefineByType ExclusionScopingMethod { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSOptimizationRegionAuto InternalObject { get; }

MaxCumulatedDisplacementControl
Gets or sets the MaxCumulatedDisplacementControl.

Declaration Syntax
public TopoPropertyControlType MaxCumulatedDisplacementControl { set;get; }

MorphingTotalMoveLimit
Gets or sets the MorphingTotalMoveLimit.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 887
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double MorphingTotalMoveLimit { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
888 of ANSYS, Inc. and its subsidiaries and affiliates.
ParameterVariable

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ParameterVariable
Defines a ParameterVariable.

Declaration Syntax
public class ParameterVariable : DataModelObject, IFolderDataModelObject

Table 301: Members

Property Children (p. 889) Gets the list of children.


Property Comments (p. 889) Gets the list of associated comments.
Property DataModelObjectCategory (p. 890) Gets the current DataModelObject's category.
Property Figures (p. 890) Gets the list of associated figures.
Property Images (p. 890) Gets the list of associated images.
Property InternalObject (p. 890) Gets the internal object. For advanced usage only.
Method AddComment() (p. 890) Creates a new child Comment.
Method AddFigure() (p. 890) Creates a new child Figure.
Method AddImage(string) (p. 891) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 891)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 891)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 889
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSParameterVariableAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
890 of ANSYS, Inc. and its subsidiaries and affiliates.
ParameterVariable

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 891
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ParameterVariableGroup
Defines a ParameterVariableGroup.

Declaration Syntax
public class ParameterVariableGroup : DataModelObject, IFolderDataModelObject

Table 302: Members

Property Children (p. 892) Gets the list of children.


Property Comments (p. 893) Gets the list of associated comments.
Property DataModelObjectCategory (p. 893) Gets the current DataModelObject's category.
Property Figures (p. 893) Gets the list of associated figures.
Property Images (p. 893) Gets the list of associated images.
Property InternalObject (p. 893) Gets the internal object. For advanced usage only.
Method AddComment() (p. 893) Creates a new child Comment.
Method AddFigure() (p. 894) Creates a new child Figure.
Method AddImage(string) (p. 894) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddParameterVariable() (p. 894) Create the object for working with an imported
part.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 894)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 895)

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
892 of ANSYS, Inc. and its subsidiaries and affiliates.
ParameterVariableGroup

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSParameterVariableGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 893
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddParameterVariable()
Create the object for working with an imported part.

Declaration Syntax
public virtual ParameterVariable AddParameterVariable()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
894 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Part
Defines a Part.

Declaration Syntax
public class Part : ImportedDataModelObject, IFolderDataModelObject

Table 303: Members

Property ApproximateSurfaceArea (p. 897) Gets the ApproximateSurfaceArea.


Property Assignment ***OBSOLETE*** Use Gets or sets the Assignment.
'Material' property instead. (p. 897)
Property Average (p. 897) Gets the Average.
Property CentroidX (p. 897) Gets the CentroidX.
Property CentroidY (p. 897) Gets the CentroidY.
Property CentroidZ (p. 897) Gets the CentroidZ.
Property Children (p. 898) Gets the list of children.
Property Comments (p. 898) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 895
Ansys.ACT.Automation.Mechanical Namespace

Property ConfigurationId (p. 898) Gets the related Result Mesh's ConfigurationId.
Property CoordinateSystem (p. 898) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 898) Gets the current DataModelObject's category.
Property Elements (p. 898) Gets the Elements.
Property Figures (p. 899) Gets the list of associated figures.
Property Hidden (p. 899) Hide or show the body.
Property Images (p. 899) Gets the list of associated images.
Property InternalObject (p. 899) Gets the internal object. For advanced usage only.
Property LengthX (p. 899) Gets the LengthX.
Property LengthY (p. 899) Gets the LengthY.
Property LengthZ (p. 900) Gets the LengthZ.
Property Mass (p. 900) Gets the Mass.
Property Material (p. 900) Gets or sets the Material.
Property MaterialName ***OBSOLETE*** Use Gets or sets the MaterialName.
'Assignment' property instead. (p. 900)
Property Maximum (p. 900) Gets the Maximum.
Property MeshMetric (p. 900) Gets the MeshMetric.
Property Minimum (p. 901) Gets the Minimum.
Property MomentOfInertiaIp1 (p. 901) Gets the MomentOfInertiaIp1.
Property MomentOfInertiaIp2 (p. 901) Gets the MomentOfInertiaIp2.
Property MomentOfInertiaIp3 (p. 901) Gets the MomentOfInertiaIp3.
Property Nodes (p. 901) Gets the Nodes.
Property ResultMeshId (p. 901) Gets the related Result Mesh's ObjectId.
Property StandardDeviation (p. 902) Gets the StandardDeviation.
Property Suppressed (p. 902) Gets or sets the Suppressed.
Property Visible (p. 902) Gets or sets the Visible.
Property Volume (p. 902) Gets the Volume.
Method AddComment() (p. 902) Creates a new child Comment.
Method AddFigure() (p. 902) Creates a new child Figure.
Method AddImage(string) (p. 903) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 903) Run the ClearGeneratedData action.
Method GenerateMesh() (p. 903) Run the GenerateMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 903)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 904)
Method PreviewInflation() (p. 904) Run the PreviewInflation action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
896 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

Method PreviewSurfaceMesh() (p. 904) Run the PreviewSurfaceMesh action.


Method Update() (p. 904) Run the Update action.

ApproximateSurfaceArea
Gets the ApproximateSurfaceArea.

Declaration Syntax
public double ApproximateSurfaceArea { get; }

Assignment ***OBSOLETE*** Use 'Material' property instead.


Gets or sets the Assignment.

Declaration Syntax
public string Assignment { set;get; }

Average
Gets the Average.

Declaration Syntax
public double Average { get; }

CentroidX
Gets the CentroidX.

Declaration Syntax
public Quantity CentroidX { get; }

CentroidY
Gets the CentroidY.

Declaration Syntax
public Quantity CentroidY { get; }

CentroidZ
Gets the CentroidZ.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 897
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity CentroidZ { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ConfigurationId
Gets the related Result Mesh's ConfigurationId.

Declaration Syntax
public int ConfigurationId { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Elements
Gets the Elements.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
898 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

Declaration Syntax
public int Elements { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Hidden
Hide or show the body.

Declaration Syntax
public bool Hidden { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSBodyGroupAuto InternalObject { get; }

LengthX
Gets the LengthX.

Declaration Syntax
public Quantity LengthX { get; }

LengthY
Gets the LengthY.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 899
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity LengthY { get; }

LengthZ
Gets the LengthZ.

Declaration Syntax
public Quantity LengthZ { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

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


Gets or sets the MaterialName.

Declaration Syntax
public string MaterialName { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

MeshMetric
Gets the MeshMetric.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
900 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

Declaration Syntax
public MeshMetricType MeshMetric { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public double Minimum { get; }

MomentOfInertiaIp1
Gets the MomentOfInertiaIp1.

Declaration Syntax
public Quantity MomentOfInertiaIp1 { get; }

MomentOfInertiaIp2
Gets the MomentOfInertiaIp2.

Declaration Syntax
public Quantity MomentOfInertiaIp2 { get; }

MomentOfInertiaIp3
Gets the MomentOfInertiaIp3.

Declaration Syntax
public Quantity MomentOfInertiaIp3 { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

ResultMeshId
Gets the related Result Mesh's ObjectId.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 901
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int ResultMeshId { get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public double StandardDeviation { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Visible
Gets or sets the Visible.

Declaration Syntax
public bool Visible { set;get; }

Volume
Gets the Volume.

Declaration Syntax
public Quantity Volume { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
902 of ANSYS, Inc. and its subsidiaries and affiliates.
Part

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

GenerateMesh()
Run the GenerateMesh action.

Declaration Syntax
public virtual void GenerateMesh()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 903
Ansys.ACT.Automation.Mechanical Namespace

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

PreviewInflation()
Run the PreviewInflation action.

Declaration Syntax
public virtual void PreviewInflation()

PreviewSurfaceMesh()
Run the PreviewSurfaceMesh action.

Declaration Syntax
public virtual void PreviewSurfaceMesh()

Update()
Run the Update action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
904 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransform

Declaration Syntax
public virtual void Update()

PartTransform
Defines a PartTransform.

Declaration Syntax
public class PartTransform : DataModelObject, IFolderDataModelObject

Table 304: Members

Property Children (p. 906) Gets the list of children.


Property Comments (p. 906) Gets the list of associated comments.
Property CoordinateSystem (p. 906) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 906) Gets the current DataModelObject's category.
Property DefineBy (p. 906) Gets or sets the DefineBy.
Property Figures (p. 906) Gets the list of associated figures.
Property Images (p. 907) Gets the list of associated images.
Property InternalObject (p. 907) Gets the internal object. For advanced usage only.
Property Location (p. 907) Gets or sets the Location.
Property RotationX (p. 907) Gets or sets the RotationX.
Property RotationY (p. 907) Gets or sets the RotationY.
Property RotationZ (p. 907) Gets or sets the RotationZ.
Property ScopingMethod (p. 908) Gets or sets the ScopingMethod.
Property SourceCoordinateSystem (p. 908) Gets or sets the SourceCoordinateSystem.
Property Suppressed (p. 908) Gets or sets the Suppressed.
Property TargetCoordinateSystem (p. 908) Gets or sets the TargetCoordinateSystem.
Property TranslationX (p. 908) Gets or sets the TranslationX.
Property TranslationY (p. 908) Gets or sets the TranslationY.
Property TranslationZ (p. 909) Gets or sets the TranslationZ.
Method AddComment() (p. 909) Creates a new child Comment.
Method AddFigure() (p. 909) Creates a new child Figure.
Method AddImage(string) (p. 909) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 909) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 910)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 905
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 910)
Method TransformGeometry() (p. 910) No details are provided for this entry.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DefineBy
Gets or sets the DefineBy.

Declaration Syntax
public PartTransformationDefinitionType DefineBy { set;get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
906 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransform

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPartTransformAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

RotationX
Gets or sets the RotationX.

Declaration Syntax
public Quantity RotationX { set;get; }

RotationY
Gets or sets the RotationY.

Declaration Syntax
public Quantity RotationY { set;get; }

RotationZ
Gets or sets the RotationZ.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 907
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity RotationZ { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SourceCoordinateSystem
Gets or sets the SourceCoordinateSystem.

Declaration Syntax
public CoordinateSystem SourceCoordinateSystem { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TargetCoordinateSystem
Gets or sets the TargetCoordinateSystem.

Declaration Syntax
public CoordinateSystem TargetCoordinateSystem { set;get; }

TranslationX
Gets or sets the TranslationX.

Declaration Syntax
public Quantity TranslationX { set;get; }

TranslationY
Gets or sets the TranslationY.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
908 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransform

Declaration Syntax
public Quantity TranslationY { set;get; }

TranslationZ
Gets or sets the TranslationZ.

Declaration Syntax
public Quantity TranslationZ { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 909
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

TransformGeometry()
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
910 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransformGroup

Declaration Syntax
public virtual void TransformGeometry()

PartTransformGroup
Defines a PartTransformGroup.

Declaration Syntax
public class PartTransformGroup : DataModelObject, IFolderDataModelObject

Table 305: Members

Property Children (p. 911) Gets the list of children.


Property Comments (p. 912) Gets the list of associated comments.
Property DataModelObjectCategory (p. 912) Gets the current DataModelObject's category.
Property Figures (p. 912) Gets the list of associated figures.
Property Images (p. 912) Gets the list of associated images.
Property InternalObject (p. 912) Gets the internal object. For advanced usage only.
Property RegenerateContacts (p. 912) Gets or sets the RegenerateContacts.
Property Suppressed (p. 913) Gets or sets the Suppressed.
Property TransformMesh (p. 913) Gets or sets the TransformMesh.
Method AddComment() (p. 913) Creates a new child Comment.
Method AddFigure() (p. 913) Creates a new child Figure.
Method AddImage(string) (p. 913) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddPartTransform() (p. 914) Creates a new PartTransform
Method Delete() (p. 914) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 914)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 914)
Method TransformGeometry() (p. 915) No details are provided for this entry.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 911
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPartTransformGroupAuto InternalObject { get; }

RegenerateContacts
Gets or sets the RegenerateContacts.

Declaration Syntax
public bool RegenerateContacts { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
912 of ANSYS, Inc. and its subsidiaries and affiliates.
PartTransformGroup

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TransformMesh
Gets or sets the TransformMesh.

Declaration Syntax
public bool TransformMesh { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 913
Ansys.ACT.Automation.Mechanical Namespace

AddPartTransform()
Creates a new PartTransform

Declaration Syntax
public virtual PartTransform AddPartTransform()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
914 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

TransformGeometry()
No details are provided for this entry.

Declaration Syntax
public virtual void TransformGeometry()

Path
Defines a Path.

Declaration Syntax
public class Path : DataModelObject, ISelectionInfo, IFolderDataModelObject

Table 306: Members

Property Children (p. 916) Gets the list of children.


Property Comments (p. 916) Gets the list of associated comments.
Property DataModelObjectCategory (p. 917) Gets the current DataModelObject's category.
Property DiscretizationPoints (p. 917) Gets or sets the DiscretizationPoints.
Property EndCoordinateSystem (p. 917) Gets or sets the EndCoordinateSystem.
Property EndXCoordinate (p. 917) Gets or sets the EndXCoordinate.
Property EndYCoordinate (p. 917) Gets or sets the EndYCoordinate.
Property EndZCoordinate (p. 917) Gets or sets the EndZCoordinate.
Property Figures (p. 918) Gets the list of associated figures.
Property HasValidGeometrySelection (p. 918) Gets the HasValidGeometrySelection.
Property Images (p. 918) Gets the list of associated images.
Property InternalObject (p. 918) Gets the internal object. For advanced usage only.
Property Location (p. 918) Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 915
Ansys.ACT.Automation.Mechanical Namespace

Property NumberOfSamplingPoints (p. 918) Gets or sets the NumberOfSamplingPoints.


Property NumberOfSubpaths (p. 919) Gets or sets the NumberOfSubpaths.
Property OffsetEdgeLocation (p. 919) Gets or sets the OffsetEdgeLocation.
Property PathCoordinateSystem (p. 919) Gets or sets the PathCoordinateSystem.
Property PathType (p. 919) Gets or sets the PathType.
Property ShowMesh (p. 919) Gets or sets the ShowMesh.
Property SnapToMeshNodes (p. 919) Gets or sets the SnapToMeshNodes.
Property StartCoordinateSystem (p. 920) Gets or sets the StartCoordinateSystem.
Property StartXCoordinate (p. 920) Gets or sets the StartXCoordinate.
Property StartYCoordinate (p. 920) Gets or sets the StartYCoordinate.
Property StartZCoordinate (p. 920) Gets or sets the StartZCoordinate.
Property Suppressed (p. 920) Gets or sets the Suppressed.
Method AddComment() (p. 920) Creates a new child Comment.
Method AddFigure() (p. 921) Creates a new child Figure.
Method AddImage(string) (p. 921) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 921) Run the Delete action.
Method FlipPathOrientatation() (p. 921) Flip Path Orientatation
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 921)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 922)
Method SnapPathToMeshNodes() (p. 922) Snap path to mesh nodes

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
916 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DiscretizationPoints
Gets or sets the DiscretizationPoints.

Declaration Syntax
public int DiscretizationPoints { set;get; }

EndCoordinateSystem
Gets or sets the EndCoordinateSystem.

Declaration Syntax
public CoordinateSystem EndCoordinateSystem { set;get; }

EndXCoordinate
Gets or sets the EndXCoordinate.

Declaration Syntax
public Quantity EndXCoordinate { set;get; }

EndYCoordinate
Gets or sets the EndYCoordinate.

Declaration Syntax
public Quantity EndYCoordinate { set;get; }

EndZCoordinate
Gets or sets the EndZCoordinate.

Declaration Syntax
public Quantity EndZCoordinate { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 917
Ansys.ACT.Automation.Mechanical Namespace

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

HasValidGeometrySelection
Gets the HasValidGeometrySelection.

Declaration Syntax
public bool HasValidGeometrySelection { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPathAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

NumberOfSamplingPoints
Gets or sets the NumberOfSamplingPoints.

Declaration Syntax
public int NumberOfSamplingPoints { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
918 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

NumberOfSubpaths
Gets or sets the NumberOfSubpaths.

Declaration Syntax
public int NumberOfSubpaths { set;get; }

OffsetEdgeLocation
Gets or sets the OffsetEdgeLocation.

Declaration Syntax
public ISelectionInfo OffsetEdgeLocation { set;get; }

PathCoordinateSystem
Gets or sets the PathCoordinateSystem.

Declaration Syntax
public CoordinateSystem PathCoordinateSystem { set;get; }

PathType
Gets or sets the PathType.

Declaration Syntax
public PathScopingType PathType { set;get; }

ShowMesh
Gets or sets the ShowMesh.

Declaration Syntax
public bool ShowMesh { set;get; }

SnapToMeshNodes
Gets or sets the SnapToMeshNodes.

Declaration Syntax
public bool SnapToMeshNodes { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 919
Ansys.ACT.Automation.Mechanical Namespace

StartCoordinateSystem
Gets or sets the StartCoordinateSystem.

Declaration Syntax
public CoordinateSystem StartCoordinateSystem { set;get; }

StartXCoordinate
Gets or sets the StartXCoordinate.

Declaration Syntax
public Quantity StartXCoordinate { set;get; }

StartYCoordinate
Gets or sets the StartYCoordinate.

Declaration Syntax
public Quantity StartYCoordinate { set;get; }

StartZCoordinate
Gets or sets the StartZCoordinate.

Declaration Syntax
public Quantity StartZCoordinate { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
920 of ANSYS, Inc. and its subsidiaries and affiliates.
Path

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

FlipPathOrientatation()
Flip Path Orientatation

Declaration Syntax
public virtual void FlipPathOrientatation()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 921
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

SnapPathToMeshNodes()
Snap path to mesh nodes

Declaration Syntax
public virtual void SnapPathToMeshNodes()

PatternRepetitionConstraint
Defines a PatternRepetitionConstraint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
922 of ANSYS, Inc. and its subsidiaries and affiliates.
PatternRepetitionConstraint

Declaration Syntax
public class PatternRepetitionConstraint : ManufacturingConstraint

Table 307: Members

Property Axis (p. 923) Gets or sets the Axis.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 923) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 923)Gets the current DataModelObject's
category.
Property InternalObject (p. 924) Gets the internal object. For advanced usage
only.
Property Location (p. 924) Gets or sets the Location.
Property Offset (p. 924) Gets or sets the Offset.
Property ScopingMethod (p. 924) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 923
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Offset
Gets or sets the Offset.

Declaration Syntax
public Quantity Offset { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

PeriodicRegion
Defines a PeriodicRegion.

Declaration Syntax
public class PeriodicRegion : SymmetryGeneral

Table 308: Members

Property Children (p. 1189) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
924 of ANSYS, Inc. and its subsidiaries and affiliates.
PeriodicRegion

(Inherited from SymmetryGeneral (p. 1188).)


Property Comments (p. 1189) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1188).)


Property CoordinateSystem (p. 1190) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1188).)


Property DataModelObjectCategory (p. 925)Gets the current DataModelObject's
category.
Property Figures (p. 1190) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1188).)


Property HighBoundaryLocation (p. 1190) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property Images (p. 1190) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1188).)


Property InternalObject (p. 925) Gets the internal object. For advanced usage
only.
Property Location (p. 1191) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 1188).)


Property LowBoundaryLocation (p. 1191) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property ScopeMode (p. 1191) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1188).)


Property Suppressed (p. 1191) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1188).)


Property Type (p. 926) Gets or sets the Type.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 925
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

Type
Gets or sets the Type.

Declaration Syntax
public PeriodicRegionType Type { set;get; }

PhysicsRegion
Defines a PhysicsRegion.

Declaration Syntax
public class PhysicsRegion : DataModelObject, IFolderDataModelObject

Table 309: Members

Property Acoustics (p. 927) Gets or sets the Acoustics.


Property ArtificiallyMatchedLayers (p. 928) Gets or sets the ArtificiallyMatchedLayers.
Property Children (p. 928) Gets the list of children.
Property Comments (p. 928) Gets the list of associated comments.
Property DataModelObjectCategory (p. 928) Gets the current DataModelObject's
category.
Property Electric (p. 928) Gets or sets the Electric.
Property ElectrostaticForce (p. 928) Gets or sets the ElectrostaticForce.
Property ElementMorphing (p. 929) Gets or sets the ElementMorphing.
Property EvanescentWaveAttenuation (p. 929) Gets or sets the
EvanescentWaveAttenuation.
Property Figures (p. 929) Gets the list of associated figures.
Property FluidBehavior (p. 929) Gets or sets the FluidBehavior.
Property Images (p. 929) Gets the list of associated images.
Property InternalObject (p. 929) Gets the internal object. For advanced
usage only.
Property Location (p. 930) Gets or sets the Location.
Property Piezoelectric (p. 930) Gets the Piezoelectric.
Property PMLElementCoordinateSystem (p. 930) Gets or sets the
PMLElementCoordinateSystem.
Property PMLOptions (p. 930) Gets or sets the PMLOptions.
Property ReferencePressure (p. 930) Gets or sets the ReferencePressure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
926 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Property ReferenceStaticPressure (p. 930) Gets or sets the ReferenceStaticPressure.


Property ReflectionCoefficient (p. 931) Gets or sets the ReflectionCoefficient.
Property ReflectionCoefficientInNegativeXDirection (p. 931) Gets or sets the
ReflectionCoefficientInNegativeXDirection.
Property ReflectionCoefficientInNegativeYDirection (p. 931) Gets or sets the
ReflectionCoefficientInNegativeYDirection.
Property ReflectionCoefficientInNegativeZDirection (p. 931) Gets or sets the
ReflectionCoefficientInNegativeZDirection.
Property ReflectionCoefficientInPositiveXDirection (p. 931) Gets or sets the
ReflectionCoefficientInPositiveXDirection.
Property ReflectionCoefficientInPositiveYDirection (p. 931) Gets or sets the
ReflectionCoefficientInPositiveYDirection.
Property ReflectionCoefficientInPositiveZDirection (p. 932) Gets or sets the
ReflectionCoefficientInPositiveZDirection.
Property ReflectionCoefficientsType (p. 932) Gets or sets the
ReflectionCoefficientsType.
Property Structural (p. 932) Gets or sets the Structural.
Property Suppressed (p. 932) Gets or sets the Suppressed.
Property Thermal (p. 932) Gets or sets the Thermal.
Property ThermalStrain (p. 932) Gets or sets the ThermalStrain.
Property ThermoelasticDamping (p. 933) Gets or sets the ThermoelasticDamping.
Method AddComment() (p. 933) Creates a new child Comment.
Method AddFigure() (p. 933) Creates a new child Figure.
Method AddImage(string) (p. 933) Creates a new child Image. If a filePath
is provided, the image will be loaded
from that file, if not, the image will be a
screen capture of the Geometry window.
Method Delete() (p. 933) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 934)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 934)
Method RenameBasedOnDefinition() (p. 934) Run the RenameBasedOnDefinition
action.
Method SelectInvalidBodiesOnPhysicsRegion() (p. 935) Run the
SelectInvalidBodiesOnPhysicsRegion
action to select bodies that are not valid.

Acoustics
Gets or sets the Acoustics.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 927
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Acoustics { set;get; }

ArtificiallyMatchedLayers
Gets or sets the ArtificiallyMatchedLayers.

Declaration Syntax
public ArtificiallyMatchedLayers ArtificiallyMatchedLayers { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Electric
Gets or sets the Electric.

Declaration Syntax
public ElectricType Electric { set;get; }

ElectrostaticForce
Gets or sets the ElectrostaticForce.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
928 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Declaration Syntax
public ElectrostaticForce ElectrostaticForce { set;get; }

ElementMorphing
Gets or sets the ElementMorphing.

Declaration Syntax
public ElementMorphingType ElementMorphing { set;get; }

EvanescentWaveAttenuation
Gets or sets the EvanescentWaveAttenuation.

Declaration Syntax
public bool EvanescentWaveAttenuation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FluidBehavior
Gets or sets the FluidBehavior.

Declaration Syntax
public FluidBehavior FluidBehavior { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 929
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSPhysicsRegionAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Piezoelectric
Gets the Piezoelectric.

Declaration Syntax
public bool Piezoelectric { get; }

PMLElementCoordinateSystem
Gets or sets the PMLElementCoordinateSystem.

Declaration Syntax
public CoordinateSystem PMLElementCoordinateSystem { set;get; }

PMLOptions
Gets or sets the PMLOptions.

Declaration Syntax
public PMLOptions PMLOptions { set;get; }

ReferencePressure
Gets or sets the ReferencePressure.

Declaration Syntax
public Quantity ReferencePressure { set;get; }

ReferenceStaticPressure
Gets or sets the ReferenceStaticPressure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
930 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Declaration Syntax
public Quantity ReferenceStaticPressure { set;get; }

ReflectionCoefficient
Gets or sets the ReflectionCoefficient.

Declaration Syntax
public double ReflectionCoefficient { set;get; }

ReflectionCoefficientInNegativeXDirection
Gets or sets the ReflectionCoefficientInNegativeXDirection.

Declaration Syntax
public double ReflectionCoefficientInNegativeXDirection { set;get; }

ReflectionCoefficientInNegativeYDirection
Gets or sets the ReflectionCoefficientInNegativeYDirection.

Declaration Syntax
public double ReflectionCoefficientInNegativeYDirection { set;get; }

ReflectionCoefficientInNegativeZDirection
Gets or sets the ReflectionCoefficientInNegativeZDirection.

Declaration Syntax
public double ReflectionCoefficientInNegativeZDirection { set;get; }

ReflectionCoefficientInPositiveXDirection
Gets or sets the ReflectionCoefficientInPositiveXDirection.

Declaration Syntax
public double ReflectionCoefficientInPositiveXDirection { set;get; }

ReflectionCoefficientInPositiveYDirection
Gets or sets the ReflectionCoefficientInPositiveYDirection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 931
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double ReflectionCoefficientInPositiveYDirection { set;get; }

ReflectionCoefficientInPositiveZDirection
Gets or sets the ReflectionCoefficientInPositiveZDirection.

Declaration Syntax
public double ReflectionCoefficientInPositiveZDirection { set;get; }

ReflectionCoefficientsType
Gets or sets the ReflectionCoefficientsType.

Declaration Syntax
public ReflectionCoefficientsType ReflectionCoefficientsType { set;get; }

Structural
Gets or sets the Structural.

Declaration Syntax
public bool Structural { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Thermal
Gets or sets the Thermal.

Declaration Syntax
public bool Thermal { set;get; }

ThermalStrain
Gets or sets the ThermalStrain.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
932 of ANSYS, Inc. and its subsidiaries and affiliates.
PhysicsRegion

Declaration Syntax
public ThermalStrainType ThermalStrain { set;get; }

ThermoelasticDamping
Gets or sets the ThermoelasticDamping.

Declaration Syntax
public ThermoelasticDampingType ThermoelasticDamping { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 933
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
934 of ANSYS, Inc. and its subsidiaries and affiliates.
PipeIdealization

Declaration Syntax
public virtual void RenameBasedOnDefinition()

SelectInvalidBodiesOnPhysicsRegion()
Run the SelectInvalidBodiesOnPhysicsRegion action to select bodies that are not valid.

Declaration Syntax
public virtual void SelectInvalidBodiesOnPhysicsRegion()

PipeIdealization
Defines a PipeIdealization.

Declaration Syntax
public class PipeIdealization : DataModelObject, IFolderDataModelObject

Table 310: Members

Property Children (p. 935) Gets the list of children.


Property DataModelObjectCategory (p. 936) Gets the current DataModelObject's
category.
Property Extend (p. 936) Gets or sets the Extend.
Property Factor (p. 936) Gets or sets the Factor.
Property GeometrySelection (p. 936) Gets or sets the GeometrySelection.
Property InternalObject (p. 936) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 936) Gets or sets the Suppressed.
Method Delete() (p. 937) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 937)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 937)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 935
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Extend
Gets or sets the Extend.

Declaration Syntax
public GrowElbowElementsBy Extend { set;get; }

Factor
Gets or sets the Factor.

Declaration Syntax
public double Factor { set;get; }

GeometrySelection
Gets or sets the GeometrySelection.

Declaration Syntax
public ISelectionInfo GeometrySelection { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPipeIdealizationAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
936 of ANSYS, Inc. and its subsidiaries and affiliates.
PipeIdealization

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 937
Ansys.ACT.Automation.Mechanical Namespace

PointMass
Defines a PointMass.

Declaration Syntax
public class PointMass : GenericPointMass

Table 311: Members

Property AppliedBy (p. 939) Gets or sets the AppliedBy.


Property BeamRadius (p. 939) Gets or sets the BeamRadius.
Property Behavior (p. 939) Gets or sets the Behavior.
Property Children (p. 568) Gets the list of children.

(Inherited from GenericPointMass (p. 568).)


Property Comments (p. 569) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 568).)


Property CoordinateSystem (p. 939) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 939) Gets the current DataModelObject's category.
Property ElementAPDLName (p. 940) Gets or sets the ElementAPDLName.
Property Figures (p. 569) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 568).)


Property Images (p. 569) Gets the list of associated images.

(Inherited from GenericPointMass (p. 568).)


Property InternalObject (p. 940) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 569) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 568).)


Property Location (p. 570) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 568).)


Property Mass (p. 940) Gets or sets the Mass.
Property MassMomentOfInertiaX (p. 940) Gets or sets the MassMomentOfInertiaX.
Property MassMomentOfInertiaY (p. 940) Gets or sets the MassMomentOfInertiaY.
Property MassMomentOfInertiaZ (p. 940) Gets or sets the MassMomentOfInertiaZ.
Property Material (p. 941) Gets or sets the Material.
Property NodalCoordinateSystem (p. 941) Gets the NodalCoordinateSystem.
Property PinballRegion (p. 941) Gets or sets the PinballRegion.
Property RemotePoint (p. 570) Gets the remote point associated to the point
mass.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
938 of ANSYS, Inc. and its subsidiaries and affiliates.
PointMass

(Inherited from GenericPointMass (p. 568).)


Property Suppressed (p. 941) Gets or sets the Suppressed.
Property XCoordinate (p. 941) Gets or sets the XCoordinate.
Property YCoordinate (p. 941) Gets or sets the YCoordinate.
Property ZCoordinate (p. 942) Gets or sets the ZCoordinate.
Method PromoteToRemotePoint() (p. 942) Run the PromoteToRemotePoint action.

AppliedBy
Gets or sets the AppliedBy.

Declaration Syntax
public RemoteApplicationType AppliedBy { set;get; }

BeamRadius
Gets or sets the BeamRadius.

Declaration Syntax
public Quantity BeamRadius { set;get; }

Behavior
Gets or sets the Behavior.

Declaration Syntax
public LoadBehavior Behavior { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 939
Ansys.ACT.Automation.Mechanical Namespace

ElementAPDLName
Gets or sets the ElementAPDLName.

Declaration Syntax
public string ElementAPDLName { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

Mass
Gets or sets the Mass.

Declaration Syntax
public Quantity Mass { set;get; }

MassMomentOfInertiaX
Gets or sets the MassMomentOfInertiaX.

Declaration Syntax
public Quantity MassMomentOfInertiaX { set;get; }

MassMomentOfInertiaY
Gets or sets the MassMomentOfInertiaY.

Declaration Syntax
public Quantity MassMomentOfInertiaY { set;get; }

MassMomentOfInertiaZ
Gets or sets the MassMomentOfInertiaZ.

Declaration Syntax
public Quantity MassMomentOfInertiaZ { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
940 of ANSYS, Inc. and its subsidiaries and affiliates.
PointMass

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

NodalCoordinateSystem
Gets the NodalCoordinateSystem.

Declaration Syntax
public CoordinateSystem NodalCoordinateSystem { get; }

PinballRegion
Gets or sets the PinballRegion.

Declaration Syntax
public Quantity PinballRegion { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

XCoordinate
Gets or sets the XCoordinate.

Declaration Syntax
public Quantity XCoordinate { set;get; }

YCoordinate
Gets or sets the YCoordinate.

Declaration Syntax
public Quantity YCoordinate { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 941
Ansys.ACT.Automation.Mechanical Namespace

ZCoordinate
Gets or sets the ZCoordinate.

Declaration Syntax
public Quantity ZCoordinate { set;get; }

PromoteToRemotePoint()
Run the PromoteToRemotePoint action.

Declaration Syntax
public virtual IEnumerable<RemotePoint> PromoteToRemotePoint()

PostContactTool
Defines a PostContactTool.

Declaration Syntax
public class PostContactTool : PreContactTool

Table 312: Members

Property Children (p. 3604) Gets the list of children.

(Inherited from ContactTool (p. 3603).)


Property Comments (p. 3604) Gets the list of associated comments.

(Inherited from ContactTool (p. 3603).)


Property DataModelObjectCategory (p. 943)Gets the current DataModelObject's
category.
Property Figures (p. 3605) Gets the list of associated figures.

(Inherited from ContactTool (p. 3603).)


Property Images (p. 3605) Gets the list of associated images.

(Inherited from ContactTool (p. 3603).)


Property InternalObject (p. 943) Gets the internal object. For advanced usage
only.
Property Location (p. 3605) Gets or sets the Location.

(Inherited from ContactTool (p. 3603).)


Property ScopingMethod (p. 3605) Gets or sets the ScopingMethod.

(Inherited from ContactTool (p. 3603).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
942 of ANSYS, Inc. and its subsidiaries and affiliates.
PostContactTool

Method AddFluidPressure() (p. 943) Creates a new ContactFluidPressure


Method AddFrictionalStress() (p. 943) Creates a new ContactFrictionalStress
Method AddHeatFlux() (p. 943) Creates a new ContactHeatFlux
Method AddPressure() (p. 944) Creates a new ContactPressure
Method AddSlidingDistance() (p. 944) Creates a new ContactSlidingDistance

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSContactToolAuto InternalObject { get; }

AddFluidPressure()
Creates a new ContactFluidPressure

Declaration Syntax
public virtual ContactFluidPressure AddFluidPressure()

AddFrictionalStress()
Creates a new ContactFrictionalStress

Declaration Syntax
public virtual ContactFrictionalStress AddFrictionalStress()

AddHeatFlux()
Creates a new ContactHeatFlux

Declaration Syntax
public virtual ContactHeatFlux AddHeatFlux()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 943
Ansys.ACT.Automation.Mechanical Namespace

AddPressure()
Creates a new ContactPressure

Declaration Syntax
public virtual ContactPressure AddPressure()

AddSlidingDistance()
Creates a new ContactSlidingDistance

Declaration Syntax
public virtual ContactSlidingDistance AddSlidingDistance()

PreContactTool
Defines a PreContactTool.

Declaration Syntax
public class PreContactTool : ContactTool

Table 313: Members

Property Children (p. 3604) Gets the list of children.

(Inherited from ContactTool (p. 3603).)


Property Comments (p. 3604) Gets the list of associated comments.

(Inherited from ContactTool (p. 3603).)


Property DataModelObjectCategory (p. 945)Gets the current DataModelObject's
category.
Property Figures (p. 3605) Gets the list of associated figures.

(Inherited from ContactTool (p. 3603).)


Property Images (p. 3605) Gets the list of associated images.

(Inherited from ContactTool (p. 3603).)


Property InternalObject (p. 945) Gets the internal object. For advanced usage
only.
Property Location (p. 3605) Gets or sets the Location.

(Inherited from ContactTool (p. 3603).)


Property ScopingMethod (p. 3605) Gets or sets the ScopingMethod.

(Inherited from ContactTool (p. 3603).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
944 of ANSYS, Inc. and its subsidiaries and affiliates.
PreContactTool

Method AddGap() (p. 945) Creates a new ContactGap


Method AddInitialInformation() (p. 945) Creates a new ContactDataTable
Method AddPenetration() (p. 945) Creates a new ContactPenetration
Method AddStatus() (p. 946) Creates a new ContactStatus

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSContactToolAuto InternalObject { get; }

AddGap()
Creates a new ContactGap

Declaration Syntax
public virtual ContactGap AddGap()

AddInitialInformation()
Creates a new ContactDataTable

Declaration Syntax
public virtual ContactDataTable AddInitialInformation()

AddPenetration()
Creates a new ContactPenetration

Declaration Syntax
public virtual ContactPenetration AddPenetration()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 945
Ansys.ACT.Automation.Mechanical Namespace

AddStatus()
Creates a new ContactStatus

Declaration Syntax
public virtual ContactStatus AddStatus()

PreMeshedCrack
Defines a PreMeshedCrack.

Declaration Syntax
public class PreMeshedCrack : GenericCrack

Table 314: Members

Property BottomFaceNodes (p. 947) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property CoordinateSystem (p. 947) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 947) Gets or sets the CrackFacesNodes.
Property CrackFront (p. 947) Gets or sets the CrackFront.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackSourceType (p. 947) Gets the CrackSourceType.
Property CrackSymmetry (p. 947) Gets or sets the CrackSymmetry.
Property DataModelObjectCategory (p. 948) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 948) Gets the internal object. For advanced usage
only.
Property ScopingMethod (p. 948) Gets the ScopingMethod.
Property SolutionContours (p. 948) Gets or sets the SolutionContours.
Property Suppressed (p. 948) Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
946 of ANSYS, Inc. and its subsidiaries and affiliates.
PreMeshedCrack

Property TopFaceNodes (p. 948) Gets or sets the TopFaceNodes.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public NamedSelection BottomFaceNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFront
Gets or sets the CrackFront.

Declaration Syntax
public NamedSelection CrackFront { set;get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

CrackSymmetry
Gets or sets the CrackSymmetry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 947
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool CrackSymmetry { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

ScopingMethod
Gets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
948 of ANSYS, Inc. and its subsidiaries and affiliates.
PreMeshedCyclicRegion

Declaration Syntax
public NamedSelection TopFaceNodes { set;get; }

PreMeshedCyclicRegion
Defines a PreMeshedCyclicRegion.

Declaration Syntax
public class PreMeshedCyclicRegion : SymmetryGeneral

Table 315: Members

Property BoundaryDOFOrientation (p. 950) Gets or sets the BoundaryDOFOrientation.


Property Children (p. 1189) Gets the list of children.

(Inherited from SymmetryGeneral (p. 1188).)


Property Comments (p. 1189) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1188).)


Property CoordinateSystem (p. 1190) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1188).)


Property DataModelObjectCategory (p. 950)Gets the current DataModelObject's
category.
Property Figures (p. 1190) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1188).)


Property HighBoundaryLocation (p. 1190) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property Images (p. 1190) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1188).)


Property InternalObject (p. 950) Gets the internal object. For advanced usage
only.
Property Location (p. 1191) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 1188).)


Property LowBoundaryLocation (p. 1191) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property NumberOfSectors (p. 950) Gets or sets the NumberOfSectors.
Property RelativeDistanceTolerance (p. 950) Gets or sets the RelativeDistanceTolerance.
Property ScopeMode (p. 1191) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1188).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 949
Ansys.ACT.Automation.Mechanical Namespace

Property Suppressed (p. 1191) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1188).)

BoundaryDOFOrientation
Gets or sets the BoundaryDOFOrientation.

Declaration Syntax
public SymmetryBoundaryDOFOrientation BoundaryDOFOrientation { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

NumberOfSectors
Gets or sets the NumberOfSectors.

Declaration Syntax
public int NumberOfSectors { set;get; }

RelativeDistanceTolerance
Gets or sets the RelativeDistanceTolerance.

Declaration Syntax
public double RelativeDistanceTolerance { set;get; }

PrimaryCriterion
Defines a PrimaryCriterion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
950 of ANSYS, Inc. and its subsidiaries and affiliates.
PrimaryCriterion

Declaration Syntax
public class PrimaryCriterion : Criterion

Table 316: Members

Property BaseResult (p. 952) Gets or sets the BaseResult.


Property BoundaryCondition (p. 952) Gets or sets the BoundaryCondition.
Property Children (p. 447) Gets the list of children.

(Inherited from Criterion (p. 446).)


Property Comments (p. 447) Gets the list of associated comments.

(Inherited from Criterion (p. 446).)


Property CoordinateSystem (p. 952) Gets or sets the Coordinate System.
Property DataModelObjectCategory (p. 952) Gets the current DataModelObject's
category.
Property DirectionX (p. 952) Gets or sets the DirectionX.
Property DirectionY (p. 953) Gets or sets the DirectionY.
Property DirectionZ (p. 953) Gets or sets the DirectionZ.
Property DiscretizationError (p. 953) Gets or sets the DiscretizationError.
Property Figures (p. 447) Gets the list of associated figures.

(Inherited from Criterion (p. 446).)


Property FrequencyRangeType (p. 953) Gets or sets the FrequencyRangeType.
Property FrequencyReduction (p. 953) Gets or sets the FrequencyReduction.
Property Images (p. 448) Gets the list of associated images.

(Inherited from Criterion (p. 446).)


Property InternalObject (p. 953) Gets the internal object. For advanced usage
only.
Property Location (p. 954) Gets or sets the Location.
Property LocationMethod (p. 954) Gets or sets the LocationMethod.
Property MaximumFrequency (p. 954) Gets or sets the MaximumFrequency.
Property MinimumFrequency (p. 954) Gets or sets the MinimumFrequency.
Property ModeNumber (p. 954) Gets or sets the ModeNumber.
Property ReferenceType (p. 954) Gets or sets the ReferenceType.
Property RemotePoint (p. 955) Gets or sets the RemotePoint.
Property RobustFrequenciesReduction (p. 955) Gets or sets the
RobustFrequenciesReduction.
Property SpatialReduction (p. 955) Gets or sets the SpatialReduction.
Property SpatialReductionMethod (p. 955) Gets or sets the SpatialReductionMethod.
Property Step (p. 955) Gets or sets the Step.
Property Suppressed (p. 448) Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 951
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from Criterion (p. 446).)


Property Value (p. 955) Gets the Value.
Property VectorReduction (p. 956) Gets or sets the VectorReduction.
Method ClearGeneratedData() (p. 956) Run the ClearGeneratedData action.
Method EvaluateAllResults() (p. 956) Run the EvaluateAllResults action.
Method RenameBasedOnDefinition() (p. 956) Run the RenameBasedOnDefinition action.

BaseResult
Gets or sets the BaseResult.

Declaration Syntax
public BaseResultType BaseResult { set;get; }

BoundaryCondition
Gets or sets the BoundaryCondition.

Declaration Syntax
public DataModelObject BoundaryCondition { set;get; }

CoordinateSystem
Gets or sets the Coordinate System.

Declaration Syntax
public ICoordinateSystemSelection CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DirectionX
Gets or sets the DirectionX.

Declaration Syntax
public double DirectionX { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
952 of ANSYS, Inc. and its subsidiaries and affiliates.
PrimaryCriterion

DirectionY
Gets or sets the DirectionY.

Declaration Syntax
public double DirectionY { set;get; }

DirectionZ
Gets or sets the DirectionZ.

Declaration Syntax
public double DirectionZ { set;get; }

DiscretizationError
Gets or sets the DiscretizationError.

Declaration Syntax
public double DiscretizationError { set;get; }

FrequencyRangeType
Gets or sets the FrequencyRangeType.

Declaration Syntax
public CriterionFrequencyRangeType FrequencyRangeType { set;get; }

FrequencyReduction
Gets or sets the FrequencyReduction.

Declaration Syntax
public FrequencyReductionType FrequencyReduction { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoCriterionAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 953
Ansys.ACT.Automation.Mechanical Namespace

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

LocationMethod
Gets or sets the LocationMethod.

Declaration Syntax
public GeometryDefineByType LocationMethod { set;get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

ModeNumber
Gets or sets the ModeNumber.

Declaration Syntax
public int ModeNumber { set;get; }

ReferenceType
Gets or sets the ReferenceType.

Declaration Syntax
public VectorReductionReferenceType ReferenceType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
954 of ANSYS, Inc. and its subsidiaries and affiliates.
PrimaryCriterion

RemotePoint
Gets or sets the RemotePoint.

Declaration Syntax
public RemotePoint RemotePoint { set;get; }

RobustFrequenciesReduction
Gets or sets the RobustFrequenciesReduction.

Declaration Syntax
public RobustFrequenciesReductionType RobustFrequenciesReduction { set;get; }

SpatialReduction
Gets or sets the SpatialReduction.

Declaration Syntax
public SpatialReductionType SpatialReduction { set;get; }

SpatialReductionMethod
Gets or sets the SpatialReductionMethod.

Declaration Syntax
public SpatialReductionMethodType SpatialReductionMethod { set;get; }

Step
Gets or sets the Step.

Declaration Syntax
public int Step { set;get; }

Value
Gets the Value.

Declaration Syntax
public Quantity Value { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 955
Ansys.ACT.Automation.Mechanical Namespace

VectorReduction
Gets or sets the VectorReduction.

Declaration Syntax
public VectorReductionType VectorReduction { set;get; }

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Project
Defines a Project.

Declaration Syntax
public class Project : DataModelObject, IFolderDataModelObject

Table 317: Members

Property Author (p. 958) Gets or sets the Author.


Property Children (p. 958) Gets the list of children.
Property Comments (p. 958) Gets the list of associated comments.
Property CreationDate (p. 958) Gets the CreationDate.
Property CreationTime (p. 959) Gets the CreationTime.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
956 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

Property DataModelObjectCategory (p. 959) Gets the current DataModelObject's category.


Property FilePath (p. 959) Gets the Mechanical Project file path of current
Mechanical session.
Property FirstSaved (p. 959) Gets the FirstSaved.
Property Images (p. 959) Gets the list of associated images.
Property ImportedSource (p. 959) Gets the ImportedSource.
Property ImportedVersion (p. 960) Gets the ImportedVersion.
Property InternalObject (p. 960) Gets the internal object. For advanced usage
only.
Property LastSaved (p. 960) Gets the LastSaved.
Property Model (p. 960) Gets the Model.
Property Models ***OBSOLETE*** Use 'Model' Gets the Model.
property instead. (p. 960)
Property PreparedFor (p. 960) Gets or sets the PreparedFor.
Property ProductVersion (p. 961) Gets the ProductVersion.
Property ProjectDirectory (p. 961) Gets the Project Directory
Property SaveProjectAfterSolution (p. 961) Gets or sets the SaveProjectAfterSolution.
Property SaveProjectBeforeSolution (p. 961) Gets or sets the SaveProjectBeforeSolution.
Property Subject (p. 961) Gets or sets the Subject.
Property UnitSystem (p. 961) Change the Unit System.
Property UserFiles (p. 962) Gets the path of the user files folder of current
project.
Method AddComment() (p. 962) Creates a new child Comment.
Method AddImage(string) (p. 962) Creates a new child Image. If a filePath is
provided, the image will be loaded from that
file, if not, the image will be a screen capture
of the Geometry window.
Method Archive(string, bool, For Mechanical opened independently, without
ArchiveSettings) (p. 962) Workbench. Archive a Mechanical project.
Method ClearGeneratedData() (p. 963) Run the ClearGeneratedData action.
Method CombineTextFiles(string, string) (p. 963) Combines two text(.txt / .dmig / .inp / .dat)
files. The secondary file will be appened to the
primary file
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 963)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 964)
Method New() (p. 964) For Mechanical opened independently, without
Workbench. Start a new Mechanical project.
Method Open(string) (p. 964) For Mechanical opened independently, without
Workbench. Open an existing Mechanical
project.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 957
Ansys.ACT.Automation.Mechanical Namespace

Method Save() (p. 965) For Mechanical opened independently, without


Workbench. Save current Mechanical project.
Method SaveAs(string, bool) (p. 965) For Mechanical opened independently, without
Workbench. Save current Mechanical project
to given filePath.
Method SpecifyMetricTemperatureInCelsius() (p. 965) Specify the use of Celsius thermal units for
metric unit systems.
Method SpecifyMetricTemperatureInKelvin() (p. 965) Specify the use of Kelvin thermal units for
metric unit systems.
Method Unarchive(string, string, bool) (p. 966) For Mechanical opened independently, without
Workbench. Unarchive a Mechanical project
and open it. If projectPath is provided, the
project will be unarchived to this given
projectPath. If projectPath is not provided or
is null or empty, the project will be unarchived
to a temporary folder. Returns a path to the
unarchived project database file.

Author
Gets or sets the Author.

Declaration Syntax
public string Author { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CreationDate
Gets the CreationDate.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
958 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

Declaration Syntax
public string CreationDate { get; }

CreationTime
Gets the CreationTime.

Declaration Syntax
public string CreationTime { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FilePath
Gets the Mechanical Project file path of current Mechanical session.

Declaration Syntax
public string FilePath { get; }

FirstSaved
Gets the FirstSaved.

Declaration Syntax
public string FirstSaved { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImportedSource
Gets the ImportedSource.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 959
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public string ImportedSource { get; }

ImportedVersion
Gets the ImportedVersion.

Declaration Syntax
public string ImportedVersion { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSProjectAuto InternalObject { get; }

LastSaved
Gets the LastSaved.

Declaration Syntax
public string LastSaved { get; }

Model
Gets the Model.

Declaration Syntax
public Model Model { get; }

Models ***OBSOLETE*** Use 'Model' property instead.


Gets the Model.

Declaration Syntax
public IEnumerable<Model> Models { get; }

PreparedFor
Gets or sets the PreparedFor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
960 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

Declaration Syntax
public string PreparedFor { set;get; }

ProductVersion
Gets the ProductVersion.

Declaration Syntax
public string ProductVersion { get; }

ProjectDirectory
Gets the Project Directory

Declaration Syntax
public string ProjectDirectory { get; }

SaveProjectAfterSolution
Gets or sets the SaveProjectAfterSolution.

Declaration Syntax
public bool SaveProjectAfterSolution { set;get; }

SaveProjectBeforeSolution
Gets or sets the SaveProjectBeforeSolution.

Declaration Syntax
public bool SaveProjectBeforeSolution { set;get; }

Subject
Gets or sets the Subject.

Declaration Syntax
public string Subject { set;get; }

UnitSystem
Change the Unit System.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 961
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public UserUnitSystemType UnitSystem { set;get; }

UserFiles
Gets the path of the user files folder of current project.

Declaration Syntax
public string UserFiles { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Archive(string, bool, ArchiveSettings)


For Mechanical opened independently, without Workbench. Archive a Mechanical project.

Declaration Syntax
public virtual void Archive(string archivePath, bool overwrite, ArchiveSettings settings)

Parameters
archivePath(string)

File path of the new archive.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
962 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

overwrite(bool)

Optional - Overwrite an existing archive file located at archivePath if one exists. The default is
False.

settings(ArchiveSettings)

Optional - Settings object to configure what files to include/exclude inside the archive file. The
default includes all files.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CombineTextFiles(string, string)
Combines two text(.txt / .dmig / .inp / .dat) files. The secondary file will be appened to the primary
file

Declaration Syntax
public virtual void CombineTextFiles(string PrimaryFileName, string SecondaryFileName)

Parameters
PrimaryFileName(string)

Path of the primary matrix file on which the secondary file will be appened

SecondaryFileName(string)

Path of the secondary matrix file

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 963
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

New()
For Mechanical opened independently, without Workbench. Start a new Mechanical project.

Declaration Syntax
public virtual void New()

Open(string)
For Mechanical opened independently, without Workbench. Open an existing Mechanical project.

Declaration Syntax
public virtual void Open(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
964 of ANSYS, Inc. and its subsidiaries and affiliates.
Project

Parameters
filePath(string)

Full absolute path of the project file.

Save()
For Mechanical opened independently, without Workbench. Save current Mechanical project.

Declaration Syntax
public virtual void Save()

SaveAs(string, bool)
For Mechanical opened independently, without Workbench. Save current Mechanical project to given
filePath.

Declaration Syntax
public virtual void SaveAs(string filePath, bool overwrite)

Parameters
filePath(string)

Full absolute path of the project file.

overwrite(bool)

Optional - Overwrite an existing project file located at filePath if one exists. The default is False.

SpecifyMetricTemperatureInCelsius()
Specify the use of Celsius thermal units for metric unit systems.

Declaration Syntax
public virtual void SpecifyMetricTemperatureInCelsius()

SpecifyMetricTemperatureInKelvin()
Specify the use of Kelvin thermal units for metric unit systems.

Declaration Syntax
public virtual void SpecifyMetricTemperatureInKelvin()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 965
Ansys.ACT.Automation.Mechanical Namespace

Unarchive(string, string, bool)


For Mechanical opened independently, without Workbench. Unarchive a Mechanical project and open
it. If projectPath is provided, the project will be unarchived to this given projectPath. If projectPath
is not provided or is null or empty, the project will be unarchived to a temporary folder. Returns a
path to the unarchived project database file.

Declaration Syntax
public virtual string Unarchive(string archivePath, string projectPath, bool overwrite)

Parameters
archivePath(string)

File path of the archive file (*.mechpz) to open.

projectPath(string)

Optional - File path where the project will be unarchived and saved.

overwrite(bool)

Optional - Overwrite an existing project located at projectPath. The default is False.

PullOutDirectionManufacturingConstraint
Defines a PullOutDirectionManufacturingConstraint.

Declaration Syntax
public class PullOutDirectionManufacturingConstraint : ManufacturingConstraint

Table 318: Members

Property Axis (p. 967) Gets or sets the Axis.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 967) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 967)Gets the current DataModelObject's
category.
Property Direction (p. 967) Gets or sets the Direction.
Property InternalObject (p. 967) Gets the internal object. For advanced usage
only.
Property Location (p. 968) Gets or sets the Location.
Property ScopingMethod (p. 968) Gets or sets the ScopingMethod.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
966 of ANSYS, Inc. and its subsidiaries and affiliates.
PullOutDirectionManufacturingConstraint

Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Subtype (p. 968) Gets or sets the Subtype.
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Direction
Gets or sets the Direction.

Declaration Syntax
public PullOutDirectionType Direction { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 967
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Subtype
Gets or sets the Subtype.

Declaration Syntax
public PullOutConstraintSubtype Subtype { set;get; }

PythonCode
Defines a PythonCode.

Declaration Syntax
public class PythonCode : DataModelObject, IExtendableObject

Table 319: Members

Property AllowRecursion (p. 969) Gets or Sets whether the PythonCode allows recursion.
Property Connected (p. 969) Gets whether the callbacks are currently connected.
Property DataModelObjectCategory (p. 969)Gets the current DataModelObject's category.
Property InternalObject (p. 969) Gets the internal object. For advanced usage only.
Property PropertyProvider (p. 969) Gets or sets the propperty provider instance associated
with this python code object.
Property ScriptExecutionScope (p. 970) The scope identifier in which the code execution will
take place.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
968 of ANSYS, Inc. and its subsidiaries and affiliates.
PythonCode

Property Text (p. 970) Gets or sets the text in the script tab for the Python Code
object.
Method Connect() (p. 970) Register the python code.
Method Delete() (p. 970) Run the Delete action.
Method ReloadProperties() (p. 970) Reload properties to update properties provided by the
provider.

AllowRecursion
Gets or Sets whether the PythonCode allows recursion.

Declaration Syntax
public bool AllowRecursion { set;get; }

Connected
Gets whether the callbacks are currently connected.

Declaration Syntax
public bool Connected { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPythonCodeAuto InternalObject { get; }

PropertyProvider
Gets or sets the propperty provider instance associated with this python code object.

Declaration Syntax
public IPropertyProvider PropertyProvider { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 969
Ansys.ACT.Automation.Mechanical Namespace

ScriptExecutionScope
The scope identifier in which the code execution will take place.

Declaration Syntax
public string ScriptExecutionScope { set;get; }

Text
Gets or sets the text in the script tab for the Python Code object.

Declaration Syntax
public string Text { set;get; }

Connect()
Register the python code.

Declaration Syntax
public virtual void Connect()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ReloadProperties()
Reload properties to update properties provided by the provider.

Declaration Syntax
public virtual void ReloadProperties()

PythonCodeEventBased
Defines a PythonCodeEventBased.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
970 of ANSYS, Inc. and its subsidiaries and affiliates.
PythonCodeEventBased

Declaration Syntax
public class PythonCodeEventBased : PythonCode

Table 320: Members

Property AllowRecursion (p. 969) Gets or Sets whether the PythonCode allows recursion.

(Inherited from PythonCode (p. 968).)


Property Connected (p. 969) Gets whether the callbacks are currently connected.

(Inherited from PythonCode (p. 968).)


Property DataModelObjectCategory (p. 971)Gets the current DataModelObject's category.
Property InternalObject (p. 971) Gets the internal object. For advanced usage only.
Property InternalObject (p. 969) Gets the internal object. For advanced usage only.

(Inherited from PythonCode (p. 968).)


Property InvalidateSolution (p. 972) Gets or sets the InvalidateSolution.
Property PropertyProvider (p. 969) Gets or sets the propperty provider instance associated
with this python code object.

(Inherited from PythonCode (p. 968).)


Property ScriptExecutionScope (p. 970) The scope identifier in which the code execution will
take place.

(Inherited from PythonCode (p. 968).)


Property SolverTarget (p. 972) Gets the SolverTarget.
Property Suppressed (p. 972) Gets or sets the Suppressed.
Property TargetCallback (p. 972) Gets or sets the TargetCallback.
Property Text (p. 970) Gets or sets the text in the script tab for the Python Code
object.

(Inherited from PythonCode (p. 968).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 971
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSPythonCodeEventBasedAuto InternalObject { get; }

InvalidateSolution
Gets or sets the InvalidateSolution.

Declaration Syntax
public bool InvalidateSolution { set;get; }

SolverTarget
Gets the SolverTarget.

Declaration Syntax
public CommandEditorTarget SolverTarget { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TargetCallback
Gets or sets the TargetCallback.

Declaration Syntax
public PythonCodeTargetCallback TargetCallback { set;get; }

ReactionForceConstraint
Defines a ReactionForceConstraint.

Declaration Syntax
public class ReactionForceConstraint : ResponseConstraint

Table 321: Members

Property AxisSelection (p. 973) Gets or sets the AxisSelection.


Property BoundType (p. 973) Gets or sets the BoundType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
972 of ANSYS, Inc. and its subsidiaries and affiliates.
ReactionForceConstraint

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 973) Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 973) Gets the internal object. For advanced usage only.
Property Location (p. 974) Gets or sets the Location.
Property ReactionForceCriteria (p. 974) Gets or sets the ReactionForceCriteria.
Property ScopingMethod (p. 974) Gets or sets the ScopingMethod.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)


Property XComponentMax (p. 974) Gets or sets the XComponentMax.
Property YComponentMax (p. 974) Gets or sets the YComponentMax.
Property ZComponentMax (p. 974) Gets or sets the ZComponentMax.

AxisSelection
Gets or sets the AxisSelection.

Declaration Syntax
public AxisSelectionType AxisSelection { set;get; }

BoundType
Gets or sets the BoundType.

Declaration Syntax
public TopoBoundType BoundType { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 973
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ReactionForceCriteria
Gets or sets the ReactionForceCriteria.

Declaration Syntax
public ReactionForceCriteriaType ReactionForceCriteria { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

XComponentMax
Gets or sets the XComponentMax.

Declaration Syntax
public Field XComponentMax { get; }

YComponentMax
Gets or sets the YComponentMax.

Declaration Syntax
public Field YComponentMax { get; }

ZComponentMax
Gets or sets the ZComponentMax.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
974 of ANSYS, Inc. and its subsidiaries and affiliates.
RectangularCrossSection

Declaration Syntax
public Field ZComponentMax { get; }

RectangularCrossSection
Defines a RectangularCrossSection.

Declaration Syntax
public class RectangularCrossSection : CrossSection

Table 322: Members

Property Area (p. 975) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 975)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Height (p. 976) Gets or sets the Height.
Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 976) Gets the internal object. For advanced usage
only.
Property IYY (p. 976) Gets the IYY.
Property IZZ (p. 976) Gets the IZZ.
Property Width (p. 976) Gets or sets the Width.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 975
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Height
Gets or sets the Height.

Declaration Syntax
public Quantity Height { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Width
Gets or sets the Width.

Declaration Syntax
public Quantity Width { set;get; }

RemotePoint
Defines a RemotePoint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
976 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

Declaration Syntax
public class RemotePoint : ImportedDataModelObject, ISelectionInfo, IFolderDataModelObject

Table 323: Members

Property Behavior (p. 978) Gets or sets the Behavior.


Property Children (p. 978) Gets the list of children.
Property Comments (p. 978) Gets the list of associated comments.
Property CoordinateSystem (p. 978) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 978) Gets the current DataModelObject's category.
Property DOFSelection (p. 979) Gets or sets the DOFSelection.
Property Formulation (p. 979) Gets or sets the Formulation.
Property GloballyAvailable (p. 979) Remote point is globally available
Property InternalObject (p. 979) Gets the internal object. For advanced usage only.
Property Location (p. 979) Gets or sets the Location.
Property Material (p. 979) Gets or sets the Material.
Property OutlineSelection (p. 980) Gets or sets the OutlineSelection.
Property PilotNodeAPDLName (p. 980) Gets or sets the PilotNodeAPDLName.
Property PilotNodeScopingType (p. 980) Gets or sets the PilotNodeScopingType.
Property PinballRegion (p. 980) Gets or sets the PinballRegion.
Property Point (p. 980) Gets or sets the Point.
Property Radius (p. 980) Gets or sets the Radius.
Property RelaxationMethod (p. 981) Gets or sets the RelaxationMethod.
Property RotationX (p. 981) Gets or sets the RotationX.
Property RotationY (p. 981) Gets or sets the RotationY.
Property RotationZ (p. 981) Gets or sets the RotationZ.
Property ScopingMethod (p. 981) Gets or sets the ScopingMethod.
Property Suppressed (p. 981) Gets or sets the Suppressed.
Property XComponent (p. 982) Gets or sets the XComponent.
Property XCoordinate (p. 982) Gets or sets the XCoordinate.
Property YComponent (p. 982) Gets or sets the YComponent.
Property YCoordinate (p. 982) Gets or sets the YCoordinate.
Property ZComponent (p. 982) Gets or sets the ZComponent.
Property ZCoordinate (p. 982) Gets or sets the ZCoordinate.
Method AddCommandSnippet() (p. 983) Creates a new CommandSnippet
Method AddComment() (p. 983) Creates a new child Comment.
Method Delete() (p. 983) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 983)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 977
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 983)
Method GetMeshRegion() (p. 984) Returns the mesh region associated to the remote
point.
Method PromoteToNamedSelection() (p. 984) Run the PromoteToNamedSelection action.

Behavior
Gets or sets the Behavior.

Declaration Syntax
public LoadBehavior Behavior { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
978 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

DOFSelection
Gets or sets the DOFSelection.

Declaration Syntax
public RemotePointDOFSelectionType DOFSelection { set;get; }

Formulation
Gets or sets the Formulation.

Declaration Syntax
public RemotePointFormulation Formulation { set;get; }

GloballyAvailable
Remote point is globally available

Declaration Syntax
public bool GloballyAvailable { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSRemotePointAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 979
Ansys.ACT.Automation.Mechanical Namespace

OutlineSelection
Gets or sets the OutlineSelection.

Declaration Syntax
public IEnumerable<RemotePoint> OutlineSelection { set;get; }

PilotNodeAPDLName
Gets or sets the PilotNodeAPDLName.

Declaration Syntax
public string PilotNodeAPDLName { set;get; }

PilotNodeScopingType
Gets or sets the PilotNodeScopingType.

Declaration Syntax
public PilotNodeScopingType PilotNodeScopingType { set;get; }

PinballRegion
Gets or sets the PinballRegion.

Declaration Syntax
public Quantity PinballRegion { set;get; }

Point
Gets or sets the Point.

Declaration Syntax
public ConstructionPoint Point { set;get; }

Radius
Gets or sets the Radius.

Declaration Syntax
public Quantity Radius { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
980 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

RelaxationMethod
Gets or sets the RelaxationMethod.

Declaration Syntax
public bool RelaxationMethod { set;get; }

RotationX
Gets or sets the RotationX.

Declaration Syntax
public ActiveOrInactive RotationX { set;get; }

RotationY
Gets or sets the RotationY.

Declaration Syntax
public ActiveOrInactive RotationY { set;get; }

RotationZ
Gets or sets the RotationZ.

Declaration Syntax
public ActiveOrInactive RotationZ { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 981
Ansys.ACT.Automation.Mechanical Namespace

XComponent
Gets or sets the XComponent.

Declaration Syntax
public ActiveOrInactive XComponent { set;get; }

XCoordinate
Gets or sets the XCoordinate.

Declaration Syntax
public Quantity XCoordinate { set;get; }

YComponent
Gets or sets the YComponent.

Declaration Syntax
public ActiveOrInactive YComponent { set;get; }

YCoordinate
Gets or sets the YCoordinate.

Declaration Syntax
public Quantity YCoordinate { set;get; }

ZComponent
Gets or sets the ZComponent.

Declaration Syntax
public ActiveOrInactive ZComponent { set;get; }

ZCoordinate
Gets or sets the ZCoordinate.

Declaration Syntax
public Quantity ZCoordinate { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
982 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoint

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 983
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetMeshRegion()
Returns the mesh region associated to the remote point.

Declaration Syntax
public virtual IMeshRegion GetMeshRegion()

PromoteToNamedSelection()
Run the PromoteToNamedSelection action.

Declaration Syntax
public virtual IEnumerable<NamedSelection> PromoteToNamedSelection()

RemotePoints
Defines a RemotePoints.

Defines a RemotePoints.

Declaration Syntax
public class RemotePoints : DataModelObject, IFolderDataModelObject

Table 324: Members

Property Children (p. 985) Gets the list of children.


Property Comments (p. 985) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
984 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoints

Property DataModelObjectCategory (p. 985) Gets the current DataModelObject's category.


Property Figures (p. 985) Gets the list of associated figures.
Property Images (p. 986) Gets the list of associated images.
Property InternalObject (p. 986) Gets the internal object. For advanced usage only.
Method AddComment() (p. 986) Creates a new child Comment.
Method AddFigure() (p. 986) Creates a new child Figure.
Method AddImage(string) (p. 986) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddRemotePoint() (p. 987) Creates a new RemotePoint
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 987)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 987)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 985
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSRemotePointGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
986 of ANSYS, Inc. and its subsidiaries and affiliates.
RemotePoints

Parameters
filePath(string)

Full path of file. Defaults to None.

AddRemotePoint()
Creates a new RemotePoint

Declaration Syntax
public virtual RemotePoint AddRemotePoint()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 987
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ResponseConstraint
Defines a ResponseConstraint.

Declaration Syntax
public abstract class ResponseConstraint : DataModelObject, IFolderDataModelObject

Table 325: Members

Property Children (p. 988) Gets the list of children.


Property DataModelObjectCategory (p. 988) Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an
Analysis object or TopoEnvironmentType
enum.
Property InternalObject (p. 989) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 989) Gets or sets the Suppressed.
Method Delete() (p. 989) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 989)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 990)
Method RenameBasedOnDefinition() (p. 990) Run the RenameBasedOnDefinition action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
988 of ANSYS, Inc. and its subsidiaries and affiliates.
ResponseConstraint

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EnvironmentSelection
Gets or Sets the EnvironmentSelection to an Analysis object or TopoEnvironmentType enum.

Declaration Syntax
public object EnvironmentSelection { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 989
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

ResponsePSDTool
Defines a ResponsePSDTool.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
990 of ANSYS, Inc. and its subsidiaries and affiliates.
ResponsePSDTool

Declaration Syntax
public class ResponsePSDTool : DataModelObject, IFolderDataModelObject

Table 326: Members

Property Children (p. 991) Gets the list of children.


Property ClusteringFrequencyPoints (p. 991) Gets or sets the ClusteringFrequencyPoints.
Property Comments (p. 992) Gets the list of associated comments.
Property DataModelObjectCategory (p. 992) Gets the current DataModelObject's category.
Property Figures (p. 992) Gets the list of associated figures.
Property Images (p. 992) Gets the list of associated images.
Property IncludeAllExcitationFrequencies (p. 992) Gets or sets the IncludeAllExcitationFrequencies.
Property IncludeUserDefinedFrequencies (p. 992) Gets or sets the IncludeUserDefinedFrequencies.
Property InternalObject (p. 993) Gets the internal object. For advanced usage only.
Method AddComment() (p. 993) Creates a new child Comment.
Method AddFigure() (p. 993) Creates a new child Figure.
Method AddImage(string) (p. 993) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddResponsePSD() (p. 993) Creates a new ResponsePSD
Method Delete() (p. 994) Run the Delete action.
Method EvaluateAllResults() (p. 994) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 994)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 994)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

ClusteringFrequencyPoints
Gets or sets the ClusteringFrequencyPoints.

Declaration Syntax
public int ClusteringFrequencyPoints { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 991
Ansys.ACT.Automation.Mechanical Namespace

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

IncludeAllExcitationFrequencies
Gets or sets the IncludeAllExcitationFrequencies.

Declaration Syntax
public bool IncludeAllExcitationFrequencies { set;get; }

IncludeUserDefinedFrequencies
Gets or sets the IncludeUserDefinedFrequencies.

Declaration Syntax
public bool IncludeUserDefinedFrequencies { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
992 of ANSYS, Inc. and its subsidiaries and affiliates.
ResponsePSDTool

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResponsePSDToolAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddResponsePSD()
Creates a new ResponsePSD

Declaration Syntax
public virtual ResponsePSD AddResponsePSD()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 993
Ansys.ACT.Automation.Mechanical Namespace

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
994 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultMesh

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ResultMesh
Defines a ResultMesh.

Declaration Syntax
public class ResultMesh : DataModelObject, IFolderDataModelObject

Table 327: Members

Property Children (p. 996) Gets the list of children.


Property Comments (p. 996) Gets the list of associated comments.
Property ConfigurationId (p. 996) Gets the ConfigurationId.
Property DataModelObjectCategory (p. 996) Gets the current DataModelObject's category.
Property Elements (p. 996) Gets the Elements.
Property FEBodies (p. 997) Gets FE Bodies
Property Figures (p. 997) Gets the list of associated figures.
Property Images (p. 997) Gets the list of associated images.
Property InternalObject (p. 997) Gets the internal object. For advanced usage
only.
Property Nodes (p. 997) Gets the Nodes.
Property SourceFile (p. 997) Gets the SourceFile.
Property Suppressed (p. 998) Gets or sets the Suppressed.
Method AddComment() (p. 998) Creates a new child Comment.
Method AddFigure() (p. 998) Creates a new child Figure.
Method AddImage(string) (p. 998) Creates a new child Image. If a filePath is
provided, the image will be loaded from that
file, if not, the image will be a screen capture
of the Geometry window.
Method AddNamedSelection() (p. 998) Creates a new NamedSelection
Method ClearGeneratedData() (p. 999) Clear the generated mesh data

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 995
Ansys.ACT.Automation.Mechanical Namespace

Method Generate() (p. 999) Generate the mesh data


Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 999)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 999)
Method ImportComponentsFromResultFile() (p. 1000)Import solver components from result file

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ConfigurationId
Gets the ConfigurationId.

Declaration Syntax
public int ConfigurationId { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Elements
Gets the Elements.

Declaration Syntax
public int Elements { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
996 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultMesh

FEBodies
Gets FE Bodies

Declaration Syntax
public Part FEBodies { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSExtraMeshAuto InternalObject { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

SourceFile
Gets the SourceFile.

Declaration Syntax
public string SourceFile { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 997
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddNamedSelection()
Creates a new NamedSelection

Declaration Syntax
public virtual NamedSelection AddNamedSelection()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
998 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultMesh

ClearGeneratedData()
Clear the generated mesh data

Declaration Syntax
public virtual void ClearGeneratedData()

Generate()
Generate the mesh data

Declaration Syntax
public virtual void Generate()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 999
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ImportComponentsFromResultFile()
Import solver components from result file

Declaration Syntax
public virtual void ImportComponentsFromResultFile()

RingCrack
Defines a RingCrack.

Declaration Syntax
public class RingCrack : GenericCrack

Table 328: Members

Property BottomFaceNodes (p. 1001) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 1002) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 1002) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 1002) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 1002) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 1002) Gets or sets the CrackFacesNodes.
Property CrackFrontNodes (p. 1002) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1000 of ANSYS, Inc. and its subsidiaries and affiliates.
RingCrack

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 1003) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 1003) Gets the CrackShape.
Property CrackSourceType (p. 1003) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 1003) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 1003) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 1003) Gets or sets the FractureAffectedZoneHeight.
Property GrowthRate (p. 1004) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InnerCrackFrontDivisions (p. 1004) Gets or sets the InnerCrackFrontDivisions.
Property InnerFrontElementSize (p. 1004) Gets or sets the InnerFrontElementSize.
Property InnerMajorRadius (p. 1004) Gets or sets the InnerMajorRadius.
Property InnerMinorRadius (p. 1004) Gets or sets the InnerMinorRadius.
Property InternalObject (p. 1004) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 1005) Gets or sets the LargestContourRadius.
Property Location (p. 1005) Gets or sets the Location.
Property MeshContours (p. 1005) Gets or sets the MeshContours.
Property OuterCrackFrontDivisions (p. 1005) Gets or sets the OuterCrackFrontDivisions.
Property OuterFrontElementSize (p. 1005) Gets or sets the OuterFrontElementSize.
Property OuterMajorRadius (p. 1005) Gets or sets the OuterMajorRadius.
Property OuterMinorRadius (p. 1006) Gets or sets the OuterMinorRadius.
Property SolutionContours (p. 1006) Gets or sets the SolutionContours.
Property Suppressed (p. 1006) Gets or sets the Suppressed.
Property Target1Nodes (p. 1006) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 1006) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 1006) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 1007) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 1007) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1001
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1002 of ANSYS, Inc. and its subsidiaries and affiliates.
RingCrack

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1003
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InnerCrackFrontDivisions
Gets or sets the InnerCrackFrontDivisions.

Declaration Syntax
public int InnerCrackFrontDivisions { set;get; }

InnerFrontElementSize
Gets or sets the InnerFrontElementSize.

Declaration Syntax
public Quantity InnerFrontElementSize { set;get; }

InnerMajorRadius
Gets or sets the InnerMajorRadius.

Declaration Syntax
public Quantity InnerMajorRadius { set;get; }

InnerMinorRadius
Gets or sets the InnerMinorRadius.

Declaration Syntax
public Quantity InnerMinorRadius { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1004 of ANSYS, Inc. and its subsidiaries and affiliates.
RingCrack

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

OuterCrackFrontDivisions
Gets or sets the OuterCrackFrontDivisions.

Declaration Syntax
public int OuterCrackFrontDivisions { set;get; }

OuterFrontElementSize
Gets or sets the OuterFrontElementSize.

Declaration Syntax
public Quantity OuterFrontElementSize { set;get; }

OuterMajorRadius
Gets or sets the OuterMajorRadius.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1005
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity OuterMajorRadius { set;get; }

OuterMinorRadius
Gets or sets the OuterMinorRadius.

Declaration Syntax
public Quantity OuterMinorRadius { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1006 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

SelectionWorksheet
No details are provided for this entry.

Declaration Syntax
public class SelectionWorksheet : Worksheet, ISelectionInfo

Table 329: Members

Property RowCount (p. 1009) No details are provided for this entry.
Method AddRow() (p. 1009) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 1009) Deletes a row from the worksheet at
index.
Method Generate() (p. 1009) Generate the selection from the
worksheet.
Method GetAction(int) (p. 1010) Gets the worksheet Action property at
index.
Method GetBodyTypeValue(int) (p. 1010) Gets the worksheet Body Type Value
property at index.
Method GetCoordinateSystemSelection(int) (p. 1010) Gets the worksheet
CoordinateSystemSelection property at
index.
Method GetCriterion(int) (p. 1010) Gets the worksheet Criterion property
at index.
Method GetCriterionActive(int) (p. 1011) Gets the worksheet CriterionActive
property at index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1007
Ansys.ACT.Automation.Mechanical Namespace

Method GetEdgeTypeValue(int) (p. 1011) Gets the worksheet Edge Type Value
property at index.
Method GetFaceTypeValue(int) (p. 1011) Gets the worksheet Face Type Value
property at index.
Method GetGeometryType(int) (p. 1012) Gets the worksheet GeometryType
property at index.
Method GetLowerBound(int) (p. 1012) Gets the worksheet LowerBound
property at index.
Method GetMeshElementTypeValue(int) (p. 1012) Gets the worksheet Mesh Element Type
Value property at index.
Method GetOperator(int) (p. 1012) Gets the worksheet Operator property
at index.
Method GetStringValue(int) (p. 1013) Gets the worksheet StringValue
property at index.
Method GetTag(uint) (p. 1013) Gets the worksheet Tag property at
index.
Method GetUpperBound(int) (p. 1013) Gets the worksheet UpperBound
property at index.
Method GetValue(int) (p. 1014) Gets the worksheet Value property at
index.
Method SetAction(int, Sets the worksheet Action property at
NamedSelectionWorksheetAction) (p. 1014) index.
Method SetBodyTypeValue(int, Sets the worksheet Body Type Value
NamedSelectionWorksheetBodyTypeValues) (p. 1014)property at index.
Method SetCoordinateSystemSelection(int, uint) (p. 1015) Sets the worksheet
CoordinateSystemSelection property at
index.
Method SetCriterion(int, Sets the worksheet Criterion property
NamedSelectionWorksheetCriterion) (p. 1015) at index.
Method SetCriterionActive(int, bool) (p. 1015) Sets the worksheet CriterionActive
property at index.
Method SetEdgeTypeValue(int, Sets the worksheet Edge Type Value
NamedSelectionWorksheetEdgeTypeValues) (p. 1016)property at index.
Method SetEntityType(int, Sets the worksheet GeometryType
NamedSelectionWorksheetEntityType) (p. 1016) property at index.
Method SetFaceTypeValue(int, Sets the worksheet Face Type Value
NamedSelectionWorksheetFaceTypeValues) (p. 1016)property at index.
Method SetLowerBound(int, double) (p. 1017) Sets the worksheet LowerBound
property at index.
Method SetMeshElementTypeValue(int, Sets the worksheet Mesh Element Type
MeshElementShape) (p. 1017) Value property at index.
Method SetOperator(int, Sets the worksheet Operator property
NamedSelectionWorksheetOperator) (p. 1017) at index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1008 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Method SetStringValue(int, string) (p. 1018) Sets the worksheet StringValue


property at index.
Method SetTag(uint, string) (p. 1018) Sets the worksheet Tag property at
index.
Method SetUpperBound(int, double) (p. 1019) Sets the worksheet UpperBound
property at index.
Method SetValue(int, double) (p. 1019) Sets the worksheet Value property at
index.

RowCount
No details are provided for this entry.

Declaration Syntax
public int RowCount { get; }

AddRow()
Adds a Row to the worksheet.

Declaration Syntax
public override int AddRow()

DeleteRow(int)
Deletes a row from the worksheet at index.

Declaration Syntax
public override void DeleteRow(int index)

Parameters
index(int)

No details are provided for this entry.

Generate()
Generate the selection from the worksheet.

Declaration Syntax
public void Generate()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1009
Ansys.ACT.Automation.Mechanical Namespace

GetAction(int)
Gets the worksheet Action property at index.

Declaration Syntax
public NamedSelectionWorksheetAction GetAction(int index)

Parameters
index(int)

No details are provided for this entry.

GetBodyTypeValue(int)
Gets the worksheet Body Type Value property at index.

Declaration Syntax
public NamedSelectionWorksheetBodyTypeValues GetBodyTypeValue(int index)

Parameters
index(int)

No details are provided for this entry.

GetCoordinateSystemSelection(int)
Gets the worksheet CoordinateSystemSelection property at index.

Declaration Syntax
public uint GetCoordinateSystemSelection(int index)

Parameters
index(int)

No details are provided for this entry.

GetCriterion(int)
Gets the worksheet Criterion property at index.

Declaration Syntax
public NamedSelectionWorksheetCriterion GetCriterion(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1010 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Parameters
index(int)

No details are provided for this entry.

GetCriterionActive(int)
Gets the worksheet CriterionActive property at index.

Declaration Syntax
public bool GetCriterionActive(int index)

Parameters
index(int)

No details are provided for this entry.

GetEdgeTypeValue(int)
Gets the worksheet Edge Type Value property at index.

Declaration Syntax
public NamedSelectionWorksheetEdgeTypeValues GetEdgeTypeValue(int index)

Parameters
index(int)

No details are provided for this entry.

GetFaceTypeValue(int)
Gets the worksheet Face Type Value property at index.

Declaration Syntax
public NamedSelectionWorksheetFaceTypeValues GetFaceTypeValue(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1011
Ansys.ACT.Automation.Mechanical Namespace

GetGeometryType(int)
Gets the worksheet GeometryType property at index.

Declaration Syntax
public NamedSelectionWorksheetEntityType GetGeometryType(int index)

Parameters
index(int)

No details are provided for this entry.

GetLowerBound(int)
Gets the worksheet LowerBound property at index.

Declaration Syntax
public double GetLowerBound(int index)

Parameters
index(int)

No details are provided for this entry.

GetMeshElementTypeValue(int)
Gets the worksheet Mesh Element Type Value property at index.

Declaration Syntax
public MeshElementShape GetMeshElementTypeValue(int index)

Parameters
index(int)

No details are provided for this entry.

GetOperator(int)
Gets the worksheet Operator property at index.

Declaration Syntax
public NamedSelectionWorksheetOperator GetOperator(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1012 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Parameters
index(int)

No details are provided for this entry.

GetStringValue(int)
Gets the worksheet StringValue property at index.

Declaration Syntax
public string GetStringValue(int index)

Parameters
index(int)

No details are provided for this entry.

GetTag(uint)
Gets the worksheet Tag property at index.

Declaration Syntax
public string GetTag(uint index)

Parameters
index(uint)

No details are provided for this entry.

GetUpperBound(int)
Gets the worksheet UpperBound property at index.

Declaration Syntax
public double GetUpperBound(int index)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1013
Ansys.ACT.Automation.Mechanical Namespace

GetValue(int)
Gets the worksheet Value property at index.

Declaration Syntax
public double GetValue(int index)

Parameters
index(int)

No details are provided for this entry.

SetAction(int, NamedSelectionWorksheetAction)
Sets the worksheet Action property at index.

Declaration Syntax
public void SetAction(int index, NamedSelectionWorksheetAction newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(NamedSelectionWorksheetAction)

No details are provided for this entry.

SetBodyTypeValue(int, NamedSelectionWorksheetBodyTypeValues)
Sets the worksheet Body Type Value property at index.

Declaration Syntax
public void SetBodyTypeValue(int index, NamedSelectionWorksheetBodyTypeValues newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(NamedSelectionWorksheetBodyTypeValues)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1014 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

SetCoordinateSystemSelection(int, uint)
Sets the worksheet CoordinateSystemSelection property at index.

Declaration Syntax
public void SetCoordinateSystemSelection(int index, uint newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(uint)

No details are provided for this entry.

SetCriterion(int, NamedSelectionWorksheetCriterion)
Sets the worksheet Criterion property at index.

Declaration Syntax
public void SetCriterion(int index, NamedSelectionWorksheetCriterion value)

Parameters
index(int)

No details are provided for this entry.

value(NamedSelectionWorksheetCriterion)

No details are provided for this entry.

SetCriterionActive(int, bool)
Sets the worksheet CriterionActive property at index.

Declaration Syntax
public void SetCriterionActive(int index, bool newVal)

Parameters
index(int)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1015
Ansys.ACT.Automation.Mechanical Namespace

newVal(bool)

No details are provided for this entry.

SetEdgeTypeValue(int, NamedSelectionWorksheetEdgeTypeValues)
Sets the worksheet Edge Type Value property at index.

Declaration Syntax
public void SetEdgeTypeValue(int index, NamedSelectionWorksheetEdgeTypeValues newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(NamedSelectionWorksheetEdgeTypeValues)

No details are provided for this entry.

SetEntityType(int, NamedSelectionWorksheetEntityType)
Sets the worksheet GeometryType property at index.

Declaration Syntax
public void SetEntityType(int index, NamedSelectionWorksheetEntityType newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(NamedSelectionWorksheetEntityType)

No details are provided for this entry.

SetFaceTypeValue(int, NamedSelectionWorksheetFaceTypeValues)
Sets the worksheet Face Type Value property at index.

Declaration Syntax
public void SetFaceTypeValue(int index, NamedSelectionWorksheetFaceTypeValues newVal)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1016 of ANSYS, Inc. and its subsidiaries and affiliates.
SelectionWorksheet

Parameters
index(int)

No details are provided for this entry.

newVal(NamedSelectionWorksheetFaceTypeValues)

No details are provided for this entry.

SetLowerBound(int, double)
Sets the worksheet LowerBound property at index.

Declaration Syntax
public void SetLowerBound(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(double)

No details are provided for this entry.

SetMeshElementTypeValue(int, MeshElementShape)
Sets the worksheet Mesh Element Type Value property at index.

Declaration Syntax
public void SetMeshElementTypeValue(int index, MeshElementShape newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(MeshElementShape)

No details are provided for this entry.

SetOperator(int, NamedSelectionWorksheetOperator)
Sets the worksheet Operator property at index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1017
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public void SetOperator(int index, NamedSelectionWorksheetOperator newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(NamedSelectionWorksheetOperator)

No details are provided for this entry.

SetStringValue(int, string)
Sets the worksheet StringValue property at index.

Declaration Syntax
public void SetStringValue(int index, string newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(string)

No details are provided for this entry.

SetTag(uint, string)
Sets the worksheet Tag property at index.

Declaration Syntax
public void SetTag(uint index, string newVal)

Parameters
index(uint)

No details are provided for this entry.

newVal(string)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1018 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

SetUpperBound(int, double)
Sets the worksheet UpperBound property at index.

Declaration Syntax
public void SetUpperBound(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(double)

No details are provided for this entry.

SetValue(int, double)
Sets the worksheet Value property at index.

Declaration Syntax
public void SetValue(int index, double newVal)

Parameters
index(int)

No details are provided for this entry.

newVal(double)

No details are provided for this entry.

SemiEllipticalCrack
Defines a SemiEllipticalCrack.

Declaration Syntax
public class SemiEllipticalCrack : GenericCrack

Table 330: Members

Property AlignWithFaceNormal (p. 1021) Gets or sets the AlignWithFaceNormal.


Property BottomFaceNodes (p. 1021) Gets or sets the BottomFaceNodes.
Property Children (p. 561) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1019
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 1021) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 1021) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 1021) Gets or sets the ContactPairsNodes.
Property CoordinateSystem (p. 1021) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 1022) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 1022) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 1022) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 1022) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 1022) Gets the CrackShape.
Property CrackSourceType (p. 1022) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 1023) Gets the current DataModelObject's
category.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 1023) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 1023) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 1023) Gets or sets the FrontElementSize.
Property GrowthRate (p. 1023) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 1023) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 1024) Gets or sets the LargestContourRadius.
Property Location (p. 1024) Gets or sets the Location.
Property MajorRadius (p. 1024) Gets or sets the MajorRadius.
Property MeshContours (p. 1024) Gets or sets the MeshContours.
Property MinorRadius (p. 1024) Gets or sets the MinorRadius.
Property ProjectToNearestSurface (p. 1024) Gets or sets the ProjectToNearestSurface.
Property SolutionContours (p. 1025) Gets or sets the SolutionContours.
Property Suppressed (p. 1025) Gets or sets the Suppressed.
Property Target1Nodes (p. 1025) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 1025) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 1025) Gets or sets the XScaleFactor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1020 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

Property YScaleFactor (p. 1025) Gets or sets the YScaleFactor.


Property ZScaleFactor (p. 1026) Gets or sets the ZScaleFactor.

AlignWithFaceNormal
Gets or sets the AlignWithFaceNormal.

Declaration Syntax
public bool AlignWithFaceNormal { set;get; }

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1021
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1022 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1023
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MajorRadius
Gets or sets the MajorRadius.

Declaration Syntax
public Quantity MajorRadius { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MinorRadius
Gets or sets the MinorRadius.

Declaration Syntax
public Quantity MinorRadius { set;get; }

ProjectToNearestSurface
Gets or sets the ProjectToNearestSurface.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1024 of ANSYS, Inc. and its subsidiaries and affiliates.
SemiEllipticalCrack

Declaration Syntax
public bool ProjectToNearestSurface { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1025
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Declaration Syntax
public double ZScaleFactor { set;get; }

SMARTCrackGrowth
Defines a SMARTCrackGrowth.

Declaration Syntax
public class SMARTCrackGrowth : GenericDelamination

Table 331: Members

Property Analysis (p. 1027) Gets the Analysis.


Property AutomaticTimeStepping (p. 1027) Gets or sets the AutomaticTimeStepping.
Property Children (p. 565) Gets the list of children.

(Inherited from GenericDelamination (p. 564).)


Property Comments (p. 565) Gets the list of associated comments.

(Inherited from GenericDelamination (p. 564).)


Property CrackGrowthLaw (p. 1027) Gets the CrackGrowthLaw.
Property CrackGrowthMethodology (p. 1028) Gets or sets the CrackGrowthMethodology.
Property CrackGrowthOption (p. 1028) Gets or sets the CrackGrowthOption.
Property CriticalRate (p. 1028) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 1028) Gets the current DataModelObject's category.
Property FailureCriteriaOption (p. 1028) Gets or sets the FailureCriteriaOption.
Property Figures (p. 565) Gets the list of associated figures.

(Inherited from GenericDelamination (p. 564).)


Property Images (p. 565) Gets the list of associated images.

(Inherited from GenericDelamination (p. 564).)


Property InitialCrack (p. 1028) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 1029) Gets or sets the InitialTimeStep.
Property InternalObject (p. 1029) Gets the internal object. For advanced usage only.
Property Material (p. 1029) Gets or sets the Material.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1026 of ANSYS, Inc. and its subsidiaries and affiliates.
SMARTCrackGrowth

Property MaximumTimeStep (p. 1029) Gets or sets the MaximumTimeStep.


Property MaxIncrementOfCrackExtension (p. 1029)Gets or sets the MaxIncrementOfCrackExtension.
Property MaxIncrementValue (p. 1029) Gets or sets the MaxIncrementValue.
Property MaxIncrementValueTreatment (p. 1030) Gets or sets the treatment type for the specified
value of MaxIncrementValue. Default: Absolute
Property MeshCoarsening (p. 1030) Gets or sets the MeshCoarsening.
Property Method (p. 1030) Gets the Method.
Property MinimumTimeStep (p. 1030) Gets or sets the MinimumTimeStep.
Property MinIncrementControl (p. 1030) Gets or sets the control type for the smaller crack
increment values.
Property MinIncrementOfCrackExtension (p. 1030)Gets or sets the MinIncrementOfCrackExtension.
Property MinIncrementValue (p. 1031) Gets or sets the MinIncrementValue.
Property MinIncrementValueTreatment (p. 1031) Gets or sets the treatment type for the specified
value of MinIncrementValue. Default: Absolute
Property NumberOfCycles (p. 1031) Gets or sets the NumberOfCycles.
Property StopCriterion (p. 1031) Gets or sets the StopCriterion.
Property StopValue (p. 1031) Gets or sets the StopValue.
Property StressRatio (p. 1031) Gets or sets the StressRatio.
Property Suppressed (p. 1032) Gets or sets the Suppressed.

Analysis
Gets the Analysis.

Declaration Syntax
public DelaminationType Analysis { get; }

AutomaticTimeStepping
Gets or sets the AutomaticTimeStepping.

Declaration Syntax
public AutomaticOrManual AutomaticTimeStepping { set;get; }

CrackGrowthLaw
Gets the CrackGrowthLaw.

Declaration Syntax
public string CrackGrowthLaw { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1027
Ansys.ACT.Automation.Mechanical Namespace

CrackGrowthMethodology
Gets or sets the CrackGrowthMethodology.

Declaration Syntax
public CrackGrowthMethodology CrackGrowthMethodology { set;get; }

CrackGrowthOption
Gets or sets the CrackGrowthOption.

Declaration Syntax
public CrackGrowthOption CrackGrowthOption { set;get; }

CriticalRate
Gets or sets the CriticalRate.

Declaration Syntax
public Quantity CriticalRate { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FailureCriteriaOption
Gets or sets the FailureCriteriaOption.

Declaration Syntax
public DelaminationFailureCriteriaOption FailureCriteriaOption { set;get; }

InitialCrack
Gets or sets the InitialCrack.

Declaration Syntax
public GenericCrack InitialCrack { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1028 of ANSYS, Inc. and its subsidiaries and affiliates.
SMARTCrackGrowth

InitialTimeStep
Gets or sets the InitialTimeStep.

Declaration Syntax
public Quantity InitialTimeStep { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

MaximumTimeStep
Gets or sets the MaximumTimeStep.

Declaration Syntax
public Quantity MaximumTimeStep { set;get; }

MaxIncrementOfCrackExtension
Gets or sets the MaxIncrementOfCrackExtension.

Declaration Syntax
public CrackGrowthIncrementType MaxIncrementOfCrackExtension { set;get; }

MaxIncrementValue
Gets or sets the MaxIncrementValue.

Declaration Syntax
public Quantity MaxIncrementValue { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1029
Ansys.ACT.Automation.Mechanical Namespace

MaxIncrementValueTreatment
Gets or sets the treatment type for the specified value of MaxIncrementValue. Default: Absolute

Declaration Syntax
public IncrementTreatment MaxIncrementValueTreatment { set;get; }

MeshCoarsening
Gets or sets the MeshCoarsening.

Declaration Syntax
public CrackGrowthMeshCoarsening MeshCoarsening { set;get; }

Method
Gets the Method.

Declaration Syntax
public DelaminationMethod Method { get; }

MinimumTimeStep
Gets or sets the MinimumTimeStep.

Declaration Syntax
public Quantity MinimumTimeStep { set;get; }

MinIncrementControl
Gets or sets the control type for the smaller crack increment values.

Declaration Syntax
public IncrementControl MinIncrementControl { set;get; }

MinIncrementOfCrackExtension
Gets or sets the MinIncrementOfCrackExtension.

Declaration Syntax
public CrackGrowthIncrementType MinIncrementOfCrackExtension { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1030 of ANSYS, Inc. and its subsidiaries and affiliates.
SMARTCrackGrowth

MinIncrementValue
Gets or sets the MinIncrementValue.

Declaration Syntax
public Quantity MinIncrementValue { set;get; }

MinIncrementValueTreatment
Gets or sets the treatment type for the specified value of MinIncrementValue. Default: Absolute

Declaration Syntax
public IncrementTreatment MinIncrementValueTreatment { set;get; }

NumberOfCycles
Gets or sets the NumberOfCycles.

Declaration Syntax
public int NumberOfCycles { set;get; }

StopCriterion
Gets or sets the StopCriterion.

Declaration Syntax
public StopCriterion StopCriterion { set;get; }

StopValue
Gets or sets the StopValue.

Declaration Syntax
public Quantity StopValue { set;get; }

StressRatio
Gets or sets the StressRatio.

Declaration Syntax
public double StressRatio { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1031
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Solid
Defines a Solid.

Declaration Syntax
public class Solid : ImportedDataModelObject, IFolderDataModelObject

Table 332: Members

Property Children (p. 1033) Gets the list of children.


Property Comments (p. 1033) Gets the list of associated comments.
Property CoordinateSystem (p. 1033) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1033) Gets the current DataModelObject's
category.
Property InternalObject (p. 1033) Gets the internal object. For advanced usage
only.
Property PartName (p. 1033) Gets the PartName.
Property X1 (p. 1034) Gets or sets the X1.
Property X2 (p. 1034) Gets or sets the X2.
Property Y1 (p. 1034) Gets or sets the Y1.
Property Y2 (p. 1034) Gets or sets the Y2.
Property Z1 (p. 1034) Gets or sets the Z1.
Property Z2 (p. 1034) Gets or sets the Z2.
Method AddComment() (p. 1035) Creates a new child Comment.
Method AddGeometry() (p. 1035) Add solid to the geometry.
Method Delete() (p. 1035) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1035)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1035)
Method RemoveGeometry() (p. 1036) Remove the solid from the geometry.
Method UpdateGeometry() (p. 1036) Update the solid on the geometry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1032 of ANSYS, Inc. and its subsidiaries and affiliates.
Solid

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSolidAuto InternalObject { get; }

PartName
Gets the PartName.

Declaration Syntax
public string PartName { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1033
Ansys.ACT.Automation.Mechanical Namespace

X1
Gets or sets the X1.

Declaration Syntax
public Quantity X1 { set;get; }

X2
Gets or sets the X2.

Declaration Syntax
public Quantity X2 { set;get; }

Y1
Gets or sets the Y1.

Declaration Syntax
public Quantity Y1 { set;get; }

Y2
Gets or sets the Y2.

Declaration Syntax
public Quantity Y2 { set;get; }

Z1
Gets or sets the Z1.

Declaration Syntax
public Quantity Z1 { set;get; }

Z2
Gets or sets the Z2.

Declaration Syntax
public Quantity Z2 { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1034 of ANSYS, Inc. and its subsidiaries and affiliates.
Solid

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddGeometry()
Add solid to the geometry.

Declaration Syntax
public virtual void AddGeometry()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1035
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RemoveGeometry()
Remove the solid from the geometry.

Declaration Syntax
public virtual void RemoveGeometry()

UpdateGeometry()
Update the solid on the geometry.

Declaration Syntax
public virtual void UpdateGeometry()

Solution
Defines a Solution.

Declaration Syntax
public class Solution : DataModelObject, IEvaluateAllResults, IFolderDataModelObject

Table 333: Members

Property AllThreadsCPUTime (p. 1047) No details are provided for this e


Property CalculateBeamSectionResults (p. 1048) Gets or sets the CalculateBeamSe
Property CellId (p. 1048) Gets the CellId.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1036 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Property Children (p. 1048) Gets the list of children.


Property Comments (p. 1048) Gets the list of associated comm
Property CyclicSectorDisplayRangeBegin (p. 1048) Gets or sets the
CyclicSectorDisplayRangeBegin.
Property DataModelObjectCategory (p. 1048) Gets the current DataModelObje
Property DateOfRun (p. 1049) No details are provided for this e
Property EigenSolverType (p. 1049) No details are provided for this e
Property ElapsedRunTime (p. 1049) Gets or sets the ElapsedRunTime
Property ElapsedTime (p. 1049) No details are provided for this e
Property ElementLoadBalRatio (p. 1049) No details are provided for this e
Property Elements (p. 1049) No details are provided for this e
Property ElementSelection (p. 1050) Gets or sets the ElementSelectio
Property EquationSolverType (p. 1050) No details are provided for this e
Property ExportTopologyFile (p. 1050) Gets or sets the ExportTopologyF
Property Figures (p. 1050) Gets the list of associated figures
Property GpuAcceleration (p. 1050) No details are provided for this e
Property GPUType (p. 1050) No details are provided for this e
Property Images (p. 1051) Gets the list of associated image
Property InternalObject (p. 1051) Gets the internal object. For adva
only.
Property IOBound (p. 1051) No details are provided for this e
Property IORead (p. 1051) No details are provided for this e
Property IOWrite (p. 1051) No details are provided for this e
Property IsAutoHybridParallel (p. 1051) Returns if Hybrid Parallel was tur
APDL or not (i.e. Automatic Hybr
Property IsDataExtractionComplete (p. 1052) No details are provided for this e
Property IsDistributedSolution (p. 1052) No details are provided for this e
Property IsEigenSolver (p. 1052) No details are provided for this e
Property IsGPUAccelerationRequested (p. 1052) No details are provided for this e
Property IsHybridParallelSolution (p. 1052) No details are provided for this e
Property IsUnsymmetricMatrixSolve (p. 1052) No details are provided for this e
Property License (p. 1053) No details are provided for this e
Property LicenseCoresAvailable (p. 1053) No details are provided for this e
Property MainThreadCPUTime (p. 1053) No details are provided for this e
Property MaximumRefinementLoops (p. 1053) Gets or sets the MaximumRefine
Property MemoryAvailable (p. 1053) No details are provided for this e
Property MemoryUsed (p. 1053) Gets or sets the MemoryUsed.
Property MeshSource (p. 1054) Gets or sets the MeshSource.
Property MPIType (p. 1054) No details are provided for this e

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1037
Ansys.ACT.Automation.Mechanical Namespace

Property MSUPHarmonicAnalysis (p. 1054) No details are provided for this e


Property Nodes (p. 1054) No details are provided for this e
Property NumberOfDOF (p. 1054) Get the Number of DOF.
Property NumberOfProcessesRequested (p. 1054) No details are provided for this e
Property NumberofSectors (p. 1055) Gets or sets the NumberofSector
Property NumCoresAvailable (p. 1055) No details are provided for this e
Property NumGPURequested (p. 1055) No details are provided for this e
Property NumMachinesRequested (p. 1055) No details are provided for this e
Property NumProcRequested (p. 1055) No details are provided for this e
Property NumVirtualCoresAvailable (p. 1055) No details are provided for this e
Property OperatingSystem (p. 1056) No details are provided for this e
Property ProcessorModel (p. 1056) No details are provided for this e
Property RefinementDepth (p. 1056) Gets or sets the RefinementDept
Property ResultFileDirectory (p. 1056) Gets the ResultFileDirectory.
Property ResultFileName (p. 1056) Gets the ResultFileName.
Property ResultFilePath (p. 1056) Get the result file full path.
Property ResultFileSize (p. 1057) Gets the ResultFileSize.
Property ResultFileTimestamp (p. 1057) Gets the ResultFileTimestamp.
Property ResultFileUnitSystem (p. 1057) Gets the ResultFileUnitSystem.
Property ResultTrackingVectorLength (p. 1057) No details are provided for this e
Property SkipSolveCommand (p. 1057) Gets or sets the flag to avoid issu
command in the MAPDL solver.
Property SolutionInformation (p. 1057) Gets the SolutionInformation.
Property SolutionTrackingVectorLength (p. 1058) No details are provided for this e
Property SolutionUnitSystem (p. 1058) No details are provided for this e
Property SolverData (p. 1058) No details are provided for this e
Property SolverType (p. 1058) No details are provided for this e
Property SparseMode (p. 1058) Get the Sparse Mode value.
Property Status (p. 1058) Gets the Status.
Property ThreadsPerProcessRequested (p. 1059) No details are provided for this e
Property TimeOfRun (p. 1059) No details are provided for this e
Property TimeToCombineDistributedFiles (p. 1059) No details are provided for this e
Property TopologyResult (p. 1059) Gets or sets the TopologyResult.
Property TotalMemoryUsed (p. 1059) No details are provided for this e
Property WorkingDir (p. 1059) Gets the WorkingDir.
Method AddAccelerationFrequencyResponse() (p. 1060) Creates a new
AccelerationFrequencyResponse
Method AddAccelerationPhaseResponse() (p. 1060) Creates a new AccelerationPhase
Method AddAccelerationProbe() (p. 1060) Creates a new AccelerationProbe

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1038 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddAccelerationWaterfallDiagram() (p. 1060) Creates a new AccelerationWater


Method AddAccumulatedEquivalentPlasticStrain() (p. 1060) Creates a new
AccumulatedEquivalentPlasticStr
Method AddAcousticAbsorptionCoefficient() (p. 1060) Creates a new AcousticAbsorptio
Method AddAcousticAWeightedSoundPressureLevel() (p. 1061) Creates a new
AcousticAWeightedSoundPressur
Method AddAcousticAWeightedSPLFrequencyResponse() (p. 1061) Creates a new
AcousticAWeightedSPLFrequency
Method AddAcousticDiffuseSoundTransmissionLoss() (p. 1061) Creates a new
AcousticDiffuseSoundTransmissio
Method AddAcousticDirectionalVelocityResult() (p. 1061) Creates a new
AcousticDirectionalVelocityResul
Method AddAcousticFarFieldAWeightedSPL() (p. 1061) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldAWeightedSPLMic() (p. 1061) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldDirectivity() (p. 1062) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldMaximumPressure() (p. 1062) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldMaximumPressureMic() (p. 1062) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldMaximumScatteredPressure() (p. 1062) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldPhase() (p. 1062) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldPhaseMic() (p. 1062) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSoundPowerLevel() (p. 1063) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSoundPowerLevelWaterfallDiagram() (p. 1063) Creates a new
AcousticFarFieldSoundPowerLeve
Method AddAcousticFarFieldSPL() (p. 1063) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSPLMic() (p. 1063) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSPLMicWaterfallDiagram() (p. 1063) Creates a new
AcousticFarFieldSPLMicWaterfallD
Method AddAcousticFarFieldTargetStrength() (p. 1063) Creates a new AcousticFarFieldRe
Method AddAcousticFrequencyBandAWeightedSPL() (p. 1064) Creates a new
AcousticFrequencyBandAWeighte
Method AddAcousticFrequencyBandSPL() (p. 1064) Creates a new AcousticFrequenc
Method AddAcousticKineticEnergy() (p. 1064) Creates a new AcousticKineticEn
Method AddAcousticKineticEnergyFrequencyResponse() (p. 1064) Creates a new
AcousticKineticEnergyFrequency
Method AddAcousticPotentialEnergy() (p. 1064) Creates a new AcousticPotentialE
Method AddAcousticPotentialEnergyFrequencyResponse() (p. 1064) Creates a new
AcousticPotentialEnergyFrequenc
Method AddAcousticPressureFrequencyResponse() (p. 1065) Creates a new
AcousticPressureFrequencyRespo
Method AddAcousticPressureResult() (p. 1065) Creates a new AcousticPressureR
Method AddAcousticReturnLoss() (p. 1065) Creates a new AcousticReturnLos

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1039
Ansys.ACT.Automation.Mechanical Namespace

Method AddAcousticSoundPressureLevel() (p. 1065) Creates a new AcousticSoundPre


Method AddAcousticSPLFrequencyResponse() (p. 1065) Creates a new
AcousticSPLFrequencyResponse
Method AddAcousticTotalVelocityResult() (p. 1065) Creates a new AcousticTotalVelo
Method AddAcousticTransmissionLoss() (p. 1066) Creates a new AcousticTransmiss
Method AddAcousticVelocityFrequencyResponse() (p. 1066) Creates a new
AcousticVelocityFrequencyRespo
Method AddAngularAccelerationProbe() (p. 1066) Creates a new AngularAccelerati
Method AddAngularVelocityProbe() (p. 1066) Creates a new AngularVelocityPr
Method AddBeamProbe() (p. 1066) Creates a new BeamProbe
Method AddBeamTool() (p. 1066) Creates a new BeamTool
Method AddBearingProbe() (p. 1067) Creates a new BearingProbe
Method AddBendingStressEquivalent() (p. 1067) Creates a new BendingStressEqu
Method AddBendingStressIntensity() (p. 1067) Creates a new BendingStressInte
Method AddBoltPretensionProbe() (p. 1067) Creates a new BoltPretensionPro
Method AddBoltTool() (p. 1067) Creates a new BoltTool
Method AddCampbellDiagram() (p. 1067) Creates a new CampbellDiagram
Method AddChargeReactionFrequencyResponse() (p. 1068) Creates a new
ChargeReactionFrequencyRespon
Method AddChargeReactionProbe() (p. 1068) Creates a new ChargeReactionPr
Method AddCommandSnippet() (p. 1068) Creates a new CommandSnippet
Method AddComment() (p. 1068) Creates a new child Comment.
Method AddCompositeCriterion() (p. 1068) Creates a new CompositeCriterio
Method AddCompositeFailureTool() (p. 1068) Creates a new CompositeFailureT
Method AddCompositeSamplingPointTool() (p. 1069) Creates a new CompositeSamplin
Method AddContactDistanceProbe() (p. 1069) Creates a new ContactDistanceP
Method AddContactTool() (p. 1069) Creates a new ContactTool
Method AddCurrentDensity() (p. 1069) Creates a new CurrentDensity
Method AddCurrentDensityProbe() (p. 1069) Creates a new CurrentDensityPro
Method AddDamageStatus() (p. 1069) Creates a new DamageStatus
Method AddDeformationFrequencyResponse() (p. 1070) Creates a new
DeformationFrequencyResponse
Method AddDeformationPhaseResponse() (p. 1070) Creates a new DeformationPhase
Method AddDeformationProbe() (p. 1070) Creates a new DeformationProbe
Method AddDirectionalAcceleration() (p. 1070) Creates a new DirectionalAcceler
Method AddDirectionalAccelerationPSD() (p. 1070) Creates a new DirectionalAcceler
Method AddDirectionalAccelerationRS() (p. 1070) Creates a new DirectionalAcceler
Method AddDirectionalAxialForce() (p. 1071) Creates a new DirectionalAxialFo
Method AddDirectionalBendingMoment() (p. 1071) Creates a new DirectionalBendin
Method AddDirectionalCurrentDensity() (p. 1071) Creates a new DirectionalCurren

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1040 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddDirectionalDeformation() (p. 1071) Creates a new DirectionalDeform


Method AddDirectionalElectricFieldIntensity() (p. 1071) Creates a new DirectionalElectric
Method AddDirectionalElectricFluxDensity() (p. 1071) Creates a new DirectionalElectric
Method AddDirectionalElectrostaticForce() (p. 1072) Creates a new DirectionalElectro
Method AddDirectionalHeatFlux() (p. 1072) Creates a new DirectionalHeatFlu
Method AddDirectionalMagneticFieldIntensity() (p. 1072) Creates a new
DirectionalMagneticFieldIntensit
Method AddDirectionalMagneticFluxDensity() (p. 1072) Creates a new DirectionalMagne
Method AddDirectionalShearForce() (p. 1072) Creates a new DirectionalShearF
Method AddDirectionalTorsionalMoment() (p. 1072) Creates a new DirectionalTorsion
Method AddDirectionalVelocity() (p. 1073) Creates a new DirectionalVelocit
Method AddDirectionalVelocityPSD() (p. 1073) Creates a new DirectionalVelocit
Method AddDirectionalVelocityRS() (p. 1073) Creates a new DirectionalVelocit
Method AddElasticStrainFrequencyResponse() (p. 1073) Creates a new ElasticStrainFrequ
Method AddElasticStrainIntensity() (p. 1073) Creates a new ElasticStrainIntens
Method AddElasticStrainPhaseResponse() (p. 1073) Creates a new ElasticStrainPhase
Method AddElectricFieldProbe() (p. 1074) Creates a new ElectricFieldProbe
Method AddElectricPotential() (p. 1074) Creates a new ElectricPotential
Method AddElectricVoltage() (p. 1074) Creates a new ElectricVoltage
Method AddElectromechanicalCouplingCoefficient() (p. 1074) Creates a new
ElectromechanicalCouplingCoeff
Method AddElementalEulerXYAngle() (p. 1074) Creates a new ElementalEulerXYA
Method AddElementalEulerXZAngle() (p. 1074) Creates a new ElementalEulerXZ
Method AddElementalEulerYZAngle() (p. 1075) Creates a new ElementalEulerYZA
Method AddElementalStrainEnergy() (p. 1075) Creates a new ElementalStrainEn
Method AddElementalTriads() (p. 1075) Creates a new ElementalTriads
Method AddEmagReactionProbe() (p. 1075) Creates a new EmagReactionPro
Method AddEnergyDissipatedPerUnitVolume() (p. 1075) Creates a new
EnergyDissipatedPerUnitVolume
Method AddEnergyProbe() (p. 1075) Creates a new EnergyProbe
Method AddEquivalentCreepStrain() (p. 1076) Creates a new EquivalentCreepSt
Method AddEquivalentCreepStrainRST() (p. 1076) Creates a new EquivalentCreepSt
Method AddEquivalentElasticStrain() (p. 1076) Creates a new EquivalentElasticS
Method AddEquivalentElasticStrainRST() (p. 1076) Creates a new EquivalentElasticS
Method AddEquivalentPlasticStrain() (p. 1076) Creates a new EquivalentPlasticS
Method AddEquivalentPlasticStrainRST() (p. 1076) Creates a new EquivalentPlasticS
Method AddEquivalentRadiatedPower() (p. 1077) Creates a new EquivalentRadiate
Method AddEquivalentRadiatedPowerLevel() (p. 1077) Creates a new EquivalentRadiate
Method AddEquivalentRadiatedPowerLevelWaterfallDiagram() (p. 1077) Creates a new
EquivalentRadiatedPowerLevelW

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1041
Ansys.ACT.Automation.Mechanical Namespace

Method AddEquivalentRadiatedPowerWaterfallDiagram() (p. 1077) Creates a new


EquivalentRadiatedPowerWaterfa
Method AddEquivalentStress() (p. 1077) Creates a new EquivalentStress
Method AddEquivalentStressPSD() (p. 1077) Creates a new EquivalentStressPS
Method AddEquivalentStressRS() (p. 1078) Creates a new EquivalentStressR
Method AddEquivalentTotalStrain() (p. 1078) Creates a new EquivalentTotalStr
Method AddExpansionSettings() (p. 1078) Creates a new ExpansionSettings
Method AddFatigueTool() (p. 1078) No details are provided for this e
Method AddFiberCompressiveDamageVariable() (p. 1078) Creates a new
FiberCompressiveDamageVariabl
Method AddFiberCompressiveFailureCriterion() (p. 1078) Creates a new
FiberCompressiveFailureCriterion
Method AddFiberTensileDamageVariable() (p. 1079) Creates a new FiberTensileDama
Method AddFiberTensileFailureCriterion() (p. 1079) Creates a new FiberTensileFailure
Method AddFieldIntensityProbe() (p. 1079) Creates a new FieldIntensityProb
Method AddFigure() (p. 1079) Creates a new child Figure.
Method AddFlexibleRotationProbe() (p. 1079) Creates a new FlexibleRotationPr
Method AddFluidFlowRate() (p. 1079) Creates a new FluidFlowRate
Method AddFluidHeatConductionRate() (p. 1080) Creates a new FluidHeatConduct
Method AddFluidHeatTransportRate() (p. 1080) Creates a new FluidHeatTranspor
Method AddFluxDensityProbe() (p. 1080) Creates a new FluxDensityProbe
Method AddFluxLinkage() (p. 1080) Creates a new FluxLinkage
Method AddForceReaction() (p. 1080) Creates a new ForceReaction
Method AddForceReactionFrequencyResponse() (p. 1080) Creates a new
ForceReactionFrequencyRespons
Method AddForceReactionsForContactRegions(IEnumerable<int>) (p. 1081) Bulk creates Force Reactions for
Regions by Contact object Ids
Method AddForceSummationProbe() (p. 1081) Creates a new ForceSummationP
Method AddFractureTool() (p. 1081) Creates a new FractureTool
Method AddGeneralizedPlaneStrainProbe() (p. 1081) Creates a new GeneralizedPlaneS
Method AddGroupedScopedACPResults(ResultType, No details are provided for this e
IEnumerable<IDataModelObject>) (p. 1081)
Method AddGroupedScopedCustomResult(IEnumerable<IDataModelObject>) (p. 1082)No details are provided for this e
Method AddHeatFluxProbe() (p. 1082) Creates a new HeatFluxProbe
Method AddImage(string) (p. 1082) Creates a new child Image. If a fi
provided, the image will be load
file, if not, the image will be a sc
of the Geometry window.
Method AddImpedanceFrequencyResponse() (p. 1083) Creates a new ImpedanceFreque
Method AddImpedanceProbe() (p. 1083) Creates a new ImpedanceProbe
Method AddInductance() (p. 1083) Creates a new Inductance

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1042 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddJointProbe() (p. 1083) Creates a new JointProbe


Method AddJouleHeat() (p. 1083) Creates a new JouleHeat
Method AddJouleHeatProbe() (p. 1084) Creates a new JouleHeatProbe
Method AddLatticeDensity() (p. 1084) Creates a new LatticeDensity
Method AddLatticeElementalDensity() (p. 1084) Creates a new LatticeElementalD
Method AddLinearizedEquivalentStress() (p. 1084) Creates a new LinearizedEquivale
Method AddLinearizedMaximumPrincipalStress() (p. 1084) Creates a new
LinearizedMaximumPrincipalStre
Method AddLinearizedMaximumShearStress() (p. 1084) Creates a new LinearizedMaximu
Method AddLinearizedMiddlePrincipalStress() (p. 1085) Creates a new LinearizedMiddleP
Method AddLinearizedMinimumPrincipalStress() (p. 1085) Creates a new
LinearizedMinimumPrincipalStres
Method AddLinearizedNormalStress() (p. 1085) Creates a new LinearizedNormal
Method AddLinearizedShearStress() (p. 1085) Creates a new LinearizedShearSt
Method AddLinearizedStressIntensity() (p. 1085) Creates a new LinearizedStressIn
Method AddLineChart2D() (p. 1085) Creates a new LineChart2D
Method AddLinePressureResult() (p. 1086) Creates a new LinePressureResul
Method AddMagneticCoenergy() (p. 1086) Creates a new MagneticCoenerg
Method AddMagneticDirectionalForces() (p. 1086) Creates a new MagneticDirection
Method AddMagneticError() (p. 1086) Creates a new MagneticError
Method AddMagneticFluxProbe() (p. 1086) Creates a new MagneticFluxProb
Method AddMagneticPotential() (p. 1086) Creates a new MagneticPotentia
Method AddMagneticTotalForces() (p. 1087) Creates a new MagneticTotalForc
Method AddMatrixCompressiveDamageVariable() (p. 1087) Creates a new
MatrixCompressiveDamageVariab
Method AddMatrixCompressiveFailureCriterion() (p. 1087) Creates a new
MatrixCompressiveFailureCriterio
Method AddMatrixTensileDamageVariable() (p. 1087) Creates a new MatrixTensileDam
Method AddMatrixTensileFailureCriterion() (p. 1087) Creates a new MatrixTensileFailu
Method AddMaximumFailureCriteria() (p. 1087) Creates a new MaximumFailureC
Method AddMaximumPrincipalElasticStrain() (p. 1088) Creates a new MaximumPrincipa
Method AddMaximumPrincipalStress() (p. 1088) Creates a new MaximumPrincipa
Method AddMaximumPrincipalThermalStrain() (p. 1088) Creates a new
MaximumPrincipalThermalStrain
Method AddMaximumShearElasticStrain() (p. 1088) Creates a new MaximumShearEla
Method AddMaximumShearStress() (p. 1088) Creates a new MaximumShearStr
Method AddMCFWaterfallDiagram() (p. 1088) Creates a new MCFWaterfallDiag
Method AddMembraneStressEquivalent() (p. 1089) Creates a new MembraneStressE
Method AddMembraneStressIntensity() (p. 1089) Creates a new MembraneStressIn
Method AddMiddlePrincipalElasticStrain() (p. 1089) Creates a new MiddlePrincipalEla

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1043
Ansys.ACT.Automation.Mechanical Namespace

Method AddMiddlePrincipalStress() (p. 1089) Creates a new MiddlePrincipalStr


Method AddMiddlePrincipalThermalStrain() (p. 1089) Creates a new MiddlePrincipalTh
Method AddMinimumPrincipalElasticStrain() (p. 1089) Creates a new MinimumPrincipa
Method AddMinimumPrincipalStress() (p. 1090) Creates a new MinimumPrincipa
Method AddMomentReaction() (p. 1090) Creates a new MomentReaction
Method AddMomentReactionsForContactRegions(IEnumerable<int>) (p. 1090) Bulk creates Moment Reactions f
Regions by Contact object Ids
Method AddMullinsDamageVariable() (p. 1090) Creates a new MullinsDamageVa
Method AddMullinsMaximumPreviousStrainEnergy() (p. 1090) Creates a new
MullinsMaximumPreviousStrainE
Method AddNewtonRaphsonResidualCharge() (p. 1091) Creates a new
NewtonRaphsonResidualCharge
Method AddNewtonRaphsonResidualForce() (p. 1091) Creates a new NewtonRaphsonR
Method AddNewtonRaphsonResidualHeat() (p. 1091) Creates a new NewtonRaphsonR
Method AddNewtonRaphsonResidualMoment() (p. 1091) Creates a new
NewtonRaphsonResidualMomen
Method AddNodalEulerXYAngle() (p. 1091) Creates a new NodalEulerXYAngl
Method AddNodalEulerXZAngle() (p. 1091) Creates a new NodalEulerXZAng
Method AddNodalEulerYZAngle() (p. 1092) Creates a new NodalEulerYZAng
Method AddNodalTriads() (p. 1092) Creates a new NodalTriads
Method AddNormalElasticStrain() (p. 1092) Creates a new NormalElasticStrai
Method AddNormalGasketPressure() (p. 1092) Creates a new NormalGasketPres
Method AddNormalGasketTotalClosure() (p. 1092) Creates a new NormalGasketTota
Method AddNormalStress() (p. 1092) Creates a new NormalStress
Method AddPosition() (p. 1093) Creates a new Position
Method AddPrimaryCriterion() (p. 1093) Creates a new PrimaryCriterion
Method AddPythonCodeEventBased() (p. 1093) Creates a new PythonCodeEvent
Method AddPythonResult() (p. 1093) Creates a new PythonResult
Method AddQualityFactor() (p. 1093) Creates a new QualityFactor
Method AddRadiationProbe() (p. 1093) Creates a new RadiationProbe
Method AddReactionProbe() (p. 1094) Creates a new ReactionProbe
Method AddReactionsForContactRegions(IEnumerable<int>) (p. 1094) Bulk creates Reactions for Contac
by Contact object Ids
Method AddResponsePSD() (p. 1094) Creates a new ResponsePSD
Method AddResponsePSDTool() (p. 1094) Creates a new ResponsePSDTool
Method AddResultMesh() (p. 1094) Creates a new ResultMesh
Method AddRotationProbe() (p. 1095) Creates a new RotationProbe
Method AddShapeFinder() (p. 1095) Creates a new ShapeFinder
Method AddShapeFinderElemental() (p. 1095) Creates a new ShapeFinderEleme
Method AddShearDamageVariable() (p. 1095) Creates a new ShearDamageVari

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1044 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method AddShearElasticStrain() (p. 1095) Creates a new ShearElasticStrain


Method AddShearGasketPressure() (p. 1095) Creates a new ShearGasketPressu
Method AddShearGasketTotalClosure() (p. 1096) Creates a new ShearGasketTotalC
Method AddShearMomentDiagramMSUM() (p. 1096) Creates a new TotalShearMomen
Method AddShearMomentDiagramMY() (p. 1096) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramMZ() (p. 1096) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUSUM() (p. 1096) Creates a new TotalShearMomen
Method AddShearMomentDiagramUY() (p. 1096) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUZ() (p. 1097) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVSUM() (p. 1097) Creates a new TotalShearMomen
Method AddShearMomentDiagramVY() (p. 1097) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVZ() (p. 1097) Creates a new
DirectionalShearMomentDiagram
Method AddShearStress() (p. 1097) Creates a new ShearStress
Method AddShellBendingStress() (p. 1097) Creates a new ShellBendingStres
Method AddShellBottomPeakStress() (p. 1098) Creates a new ShellBottomPeakS
Method AddShellMembraneStress() (p. 1098) Creates a new ShellMembraneSt
Method AddShellTopPeakStress() (p. 1098) Creates a new ShellTopPeakStres
Method AddSpringProbe() (p. 1098) Creates a new SpringProbe
Method AddStabilizationEnergy() (p. 1098) Creates a new StabilizationEnerg
Method AddStrainProbe() (p. 1098) Creates a new StrainProbe
Method AddStressFrequencyResponse() (p. 1099) Creates a new StressFrequencyRe
Method AddStressIntensity() (p. 1099) Creates a new StressIntensity
Method AddStressPhaseResponse() (p. 1099) Creates a new StressPhaseRespo
Method AddStressProbe() (p. 1099) Creates a new StressProbe
Method AddStressTool() (p. 1099) Creates a new StressTool
Method AddStructuralError() (p. 1099) Creates a new StructuralError
Method AddStructuralStrainEnergy() (p. 1100) Creates a new StructuralStrainEn
Method AddTemperature() (p. 1100) Creates a new TemperatureResul
Method AddTemperatureProbe() (p. 1100) Creates a new TemperatureProbe
Method AddThermalError() (p. 1100) Creates a new ThermalError
Method AddThermalStrain() (p. 1100) Creates a new DirectionalTherma
Method AddThermalStrainEnergy() (p. 1100) Creates a new ThermalStrainEner
Method AddTopologyDensity() (p. 1101) Creates a new TopologyDensity
Method AddTopologyElementalDensity() (p. 1101) Creates a new TopologyElementa

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1045
Ansys.ACT.Automation.Mechanical Namespace

Method AddTorqueProbe() (p. 1101) Creates a new TorqueProbe


Method AddTotalAcceleration() (p. 1101) Creates a new TotalAcceleration
Method AddTotalAxialForce() (p. 1101) Creates a new TotalAxialForce
Method AddTotalBendingMoment() (p. 1101) Creates a new TotalBendingMom
Method AddTotalCurrentDensity() (p. 1102) Creates a new TotalCurrentDensi
Method AddTotalDeformation() (p. 1102) Creates a new TotalDeformation
Method AddTotalElectricFieldIntensity() (p. 1102) Creates a new TotalElectricFieldIn
Method AddTotalElectricFluxDensity() (p. 1102) Creates a new TotalElectricFluxD
Method AddTotalElectrostaticForce() (p. 1102) Creates a new TotalElectrostaticF
Method AddTotalHeatFlux() (p. 1102) Creates a new TotalHeatFlux
Method AddTotalMagneticFieldIntensity() (p. 1103) Creates a new TotalMagneticField
Method AddTotalMagneticFluxDensity() (p. 1103) Creates a new TotalMagneticFlux
Method AddTotalShearForce() (p. 1103) Creates a new TotalShearForce
Method AddTotalTorsionalMoment() (p. 1103) Creates a new TotalTorsionalMom
Method AddTotalVelocity() (p. 1103) Creates a new TotalVelocity
Method AddUserDefinedResult() (p. 1103) Creates a new UserDefinedResul
Method AddVariableGraph() (p. 1104) Creates a new VariableGraph
Method AddVectorAxialForce() (p. 1104) Creates a new VectorAxialForce
Method AddVectorBendingMoment() (p. 1104) Creates a new VectorBendingMo
Method AddVectorDeformation() (p. 1104) Creates a new VectorDeformatio
Method AddVectorHeatFlux() (p. 1104) Creates a new VectorHeatFlux
Method AddVectorPrincipalElasticStrain() (p. 1104) Creates a new VectorPrincipalEla
Method AddVectorPrincipalStress() (p. 1105) Creates a new VectorPrincipalStr
Method AddVectorShearForce() (p. 1105) Creates a new VectorShearForce
Method AddVectorTorsionalMoment() (p. 1105) Creates a new VectorTorsionalMo
Method AddVelocityFrequencyResponse() (p. 1105) Creates a new VelocityFrequency
Method AddVelocityPhaseResponse() (p. 1105) Creates a new VelocityPhaseResp
Method AddVelocityProbe() (p. 1105) Creates a new VelocityProbe
Method AddVelocityWaterfallDiagram() (p. 1106) Creates a new VelocityWaterfallD
Method AddVoltageFrequencyResponse() (p. 1106) Creates a new VoltageFrequency
Method AddVoltageProbe() (p. 1106) Creates a new ElectricVoltagePro
Method AddVolume() (p. 1106) Creates a new Volume
Method AddVolumeProbe() (p. 1106) Creates a new VolumeProbe
Method ClearGeneratedData() (p. 1106) Run the ClearGeneratedData act
Method ClearRemoteStorageData() (p. 1107) No details are provided for this e
Method CreateResultsAtAllSets(uint) (p. 1107) No details are provided for this e
Method DeleteRow(uint) (p. 1107) No details are provided for this e
Method DisconnectRemoteJob() (p. 1107) No details are provided for this e
Method EvaluateAllContactTrackers() (p. 1107) No details are provided for this e

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1046 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Method EvaluateAllResults() (p. 1108) Run the EvaluateAllResults action


Method EvaluateContactTracker() (p. 1108) No details are provided for this e
Method ExecutePostCommands() (p. 1108) Run Execute Post Commands for
command objects.
Method ExecutePostCommands(IEnumerable<IDataModelObject>) (p. 1108) Run Execute Post Commands for
post commands objects.
Method ExportSubstructure(string, ExportFormat, ExportSettings) (p. 1108) Export Substructure to cpa file.
Method ExtractSolutionStatistics() (p. 1109) No details are provided for this e
Method FetchRemoteResults() (p. 1109) No details are provided for this e
Method FormatValue(double, int) (p. 1109) No details are provided for this e
Method GenerateAdaptedMesh() (p. 1110) No details are provided for this e
Method GetChildren<ChildrenType>(bool, IList<ChildrenType>) (p. 1110) Gets the list of children, filtered b
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered b
IList<IDataModelObject>) (p. 1110)
Method GetResults() (p. 1111) Gets the Results from the server.
Method IsResultFileChanged() (p. 1111) Checks if the referenced result fi
changed.
Method IsResultFileSameAsLoaded(string) (p. 1111) Checks if the given result file is s
loaded result file
Method OpenSolverFilesDirectory() (p. 1111) Run the OpenSolverFilesDirector
Method ReadAnsysResultFile() (p. 1111) Run the Ansys ReadResults actio
Method ReadGivenAnsysResultFile(string, UnitSystemIDType) (p. 1112) Run the given Ansys ReadResults
Method ReadGivenAnsysResultFileByReference(string, UnitSystemIDType) (p. 1112) Run the given Ansys ReadResults
action.///
Method ReconnectRemoteJob() (p. 1112) No details are provided for this e
Method RelinkResultFile(string) (p. 1113) Relink the result file. This action
repairing the result file referencin
altering the generated result dat
Method ReloadResultFile() (p. 1113) Reload the result file. For results-
this action reloads the result me
resets all result scopings.
Method Solve(bool, SolveConfiguration) (p. 1113) Run the Solve action.
Method Solve(bool, string) (p. 1113) Run the Solve action.
Method ValueForResultTracking(uint, string) (p. 1114) No details are provided for this e
Method ValueForSolutionTracking(uint, string) (p. 1114) No details are provided for this e

AllThreadsCPUTime
No details are provided for this entry.

Declaration Syntax
public double AllThreadsCPUTime { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1047
Ansys.ACT.Automation.Mechanical Namespace

CalculateBeamSectionResults
Gets or sets the CalculateBeamSectionResults.

Declaration Syntax
public bool CalculateBeamSectionResults { set;get; }

CellId
Gets the CellId.

Declaration Syntax
public string CellId { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CyclicSectorDisplayRangeBegin
Gets or sets the CyclicSectorDisplayRangeBegin.

Declaration Syntax
public int CyclicSectorDisplayRangeBegin { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1048 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

DateOfRun
No details are provided for this entry.

Declaration Syntax
public string DateOfRun { get; }

EigenSolverType
No details are provided for this entry.

Declaration Syntax
public EigenSolverType EigenSolverType { get; }

ElapsedRunTime
Gets or sets the ElapsedRunTime.

Declaration Syntax
public double ElapsedRunTime { set;get; }

ElapsedTime
No details are provided for this entry.

Declaration Syntax
public double ElapsedTime { get; }

ElementLoadBalRatio
No details are provided for this entry.

Declaration Syntax
public double ElementLoadBalRatio { get; }

Elements
No details are provided for this entry.

Declaration Syntax
public int Elements { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1049
Ansys.ACT.Automation.Mechanical Namespace

ElementSelection
Gets or sets the ElementSelection.

Declaration Syntax
public ConvergenceControlType ElementSelection { set;get; }

EquationSolverType
No details are provided for this entry.

Declaration Syntax
public EquationSolverType EquationSolverType { get; }

ExportTopologyFile
Gets or sets the ExportTopologyFile.

Declaration Syntax
public ExportTopologyFileOption ExportTopologyFile { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GpuAcceleration
No details are provided for this entry.

Declaration Syntax
public string GpuAcceleration { get; }

GPUType
No details are provided for this entry.

Declaration Syntax
public DSGPUType GPUType { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1050 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSAnswerSetAuto InternalObject { get; }

IOBound
No details are provided for this entry.

Declaration Syntax
public bool IOBound { get; }

IORead
No details are provided for this entry.

Declaration Syntax
public double IORead { get; }

IOWrite
No details are provided for this entry.

Declaration Syntax
public double IOWrite { get; }

IsAutoHybridParallel
Returns if Hybrid Parallel was turned on by APDL or not (i.e. Automatic Hybrid Parallel)

Declaration Syntax
public bool IsAutoHybridParallel { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1051
Ansys.ACT.Automation.Mechanical Namespace

IsDataExtractionComplete
No details are provided for this entry.

Declaration Syntax
public bool IsDataExtractionComplete { get; }

IsDistributedSolution
No details are provided for this entry.

Declaration Syntax
public bool IsDistributedSolution { get; }

IsEigenSolver
No details are provided for this entry.

Declaration Syntax
public bool IsEigenSolver { get; }

IsGPUAccelerationRequested
No details are provided for this entry.

Declaration Syntax
public bool IsGPUAccelerationRequested { get; }

IsHybridParallelSolution
No details are provided for this entry.

Declaration Syntax
public bool IsHybridParallelSolution { get; }

IsUnsymmetricMatrixSolve
No details are provided for this entry.

Declaration Syntax
public bool IsUnsymmetricMatrixSolve { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1052 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

License
No details are provided for this entry.

Declaration Syntax
public string License { get; }

LicenseCoresAvailable
No details are provided for this entry.

Declaration Syntax
public int LicenseCoresAvailable { get; }

MainThreadCPUTime
No details are provided for this entry.

Declaration Syntax
public double MainThreadCPUTime { get; }

MaximumRefinementLoops
Gets or sets the MaximumRefinementLoops.

Declaration Syntax
public int MaximumRefinementLoops { set;get; }

MemoryAvailable
No details are provided for this entry.

Declaration Syntax
public double MemoryAvailable { get; }

MemoryUsed
Gets or sets the MemoryUsed.

Declaration Syntax
public double MemoryUsed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1053
Ansys.ACT.Automation.Mechanical Namespace

MeshSource
Gets or sets the MeshSource.

Declaration Syntax
public MeshSourceType MeshSource { set;get; }

MPIType
No details are provided for this entry.

Declaration Syntax
public MPIType MPIType { get; }

MSUPHarmonicAnalysis
No details are provided for this entry.

Declaration Syntax
public bool MSUPHarmonicAnalysis { get; }

Nodes
No details are provided for this entry.

Declaration Syntax
public int Nodes { get; }

NumberOfDOF
Get the Number of DOF.

Declaration Syntax
public int NumberOfDOF { get; }

NumberOfProcessesRequested
No details are provided for this entry.

Declaration Syntax
public int NumberOfProcessesRequested { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1054 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

NumberofSectors
Gets or sets the NumberofSectors.

Declaration Syntax
public int NumberofSectors { set;get; }

NumCoresAvailable
No details are provided for this entry.

Declaration Syntax
public int NumCoresAvailable { get; }

NumGPURequested
No details are provided for this entry.

Declaration Syntax
public int NumGPURequested { get; }

NumMachinesRequested
No details are provided for this entry.

Declaration Syntax
public int NumMachinesRequested { get; }

NumProcRequested
No details are provided for this entry.

Declaration Syntax
public int NumProcRequested { get; }

NumVirtualCoresAvailable
No details are provided for this entry.

Declaration Syntax
public int NumVirtualCoresAvailable { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1055
Ansys.ACT.Automation.Mechanical Namespace

OperatingSystem
No details are provided for this entry.

Declaration Syntax
public string OperatingSystem { get; }

ProcessorModel
No details are provided for this entry.

Declaration Syntax
public string ProcessorModel { get; }

RefinementDepth
Gets or sets the RefinementDepth.

Declaration Syntax
public int RefinementDepth { set;get; }

ResultFileDirectory
Gets the ResultFileDirectory.

Declaration Syntax
public string ResultFileDirectory { get; }

ResultFileName
Gets the ResultFileName.

Declaration Syntax
public string ResultFileName { get; }

ResultFilePath
Get the result file full path.

Declaration Syntax
public string ResultFilePath { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1056 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

ResultFileSize
Gets the ResultFileSize.

Declaration Syntax
public double ResultFileSize { get; }

ResultFileTimestamp
Gets the ResultFileTimestamp.

Declaration Syntax
public string ResultFileTimestamp { get; }

ResultFileUnitSystem
Gets the ResultFileUnitSystem.

Declaration Syntax
public WBUnitSystemType ResultFileUnitSystem { get; }

ResultTrackingVectorLength
No details are provided for this entry.

Declaration Syntax
public int ResultTrackingVectorLength { get; }

SkipSolveCommand
Gets or sets the flag to avoid issuing the solve command in the MAPDL solver.

Declaration Syntax
public bool SkipSolveCommand { set;get; }

SolutionInformation
Gets the SolutionInformation.

Declaration Syntax
public SolutionInformation SolutionInformation { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1057
Ansys.ACT.Automation.Mechanical Namespace

SolutionTrackingVectorLength
No details are provided for this entry.

Declaration Syntax
public int SolutionTrackingVectorLength { get; }

SolutionUnitSystem
No details are provided for this entry.

Declaration Syntax
public MechanicalUnitSystem SolutionUnitSystem { get; }

SolverData
No details are provided for this entry.

Declaration Syntax
public object SolverData { get; }

SolverType
No details are provided for this entry.

Declaration Syntax
public SolverType SolverType { get; }

SparseMode
Get the Sparse Mode value.

Declaration Syntax
public int SparseMode { get; }

Status
Gets the Status.

Declaration Syntax
public SolutionStatusType Status { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1058 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

ThreadsPerProcessRequested
No details are provided for this entry.

Declaration Syntax
public int ThreadsPerProcessRequested { get; }

TimeOfRun
No details are provided for this entry.

Declaration Syntax
public string TimeOfRun { get; }

TimeToCombineDistributedFiles
No details are provided for this entry.

Declaration Syntax
public double TimeToCombineDistributedFiles { get; }

TopologyResult
Gets or sets the TopologyResult.

Declaration Syntax
public DataModelObject TopologyResult { set;get; }

TotalMemoryUsed
No details are provided for this entry.

Declaration Syntax
public double TotalMemoryUsed { get; }

WorkingDir
Gets the WorkingDir.

Declaration Syntax
public string WorkingDir { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1059
Ansys.ACT.Automation.Mechanical Namespace

AddAccelerationFrequencyResponse()
Creates a new AccelerationFrequencyResponse

Declaration Syntax
public virtual AccelerationFrequencyResponse AddAccelerationFrequencyResponse()

AddAccelerationPhaseResponse()
Creates a new AccelerationPhaseResponse

Declaration Syntax
public virtual AccelerationPhaseResponse AddAccelerationPhaseResponse()

AddAccelerationProbe()
Creates a new AccelerationProbe

Declaration Syntax
public virtual AccelerationProbe AddAccelerationProbe()

AddAccelerationWaterfallDiagram()
Creates a new AccelerationWaterfallDiagram

Declaration Syntax
public virtual AccelerationWaterfallDiagram AddAccelerationWaterfallDiagram()

AddAccumulatedEquivalentPlasticStrain()
Creates a new AccumulatedEquivalentPlasticStrain

Declaration Syntax
public virtual AccumulatedEquivalentPlasticStrain AddAccumulatedEquivalentPlasticStrain()

AddAcousticAbsorptionCoefficient()
Creates a new AcousticAbsorptionCoefficient

Declaration Syntax
public virtual AcousticAbsorptionCoefficient AddAcousticAbsorptionCoefficient()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1060 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddAcousticAWeightedSoundPressureLevel()
Creates a new AcousticAWeightedSoundPressureLevel

Declaration Syntax
public virtual AcousticAWeightedSoundPressureLevel AddAcousticAWeightedSoundPressureLevel()

AddAcousticAWeightedSPLFrequencyResponse()
Creates a new AcousticAWeightedSPLFrequencyResponse

Declaration Syntax
public virtual AcousticAWeightedSPLFrequencyResponse AddAcousticAWeightedSPLFrequencyRe-
sponse()

AddAcousticDiffuseSoundTransmissionLoss()
Creates a new AcousticDiffuseSoundTransmissionLoss

Declaration Syntax
public virtual AcousticDiffuseSoundTransmissionLoss AddAcousticDiffuseSoundTransmissionLoss()

AddAcousticDirectionalVelocityResult()
Creates a new AcousticDirectionalVelocityResult

Declaration Syntax
public virtual AcousticDirectionalVelocityResult AddAcousticDirectionalVelocityResult()

AddAcousticFarFieldAWeightedSPL()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldAWeightedSPL()

AddAcousticFarFieldAWeightedSPLMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldAWeightedSPLMic()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1061
Ansys.ACT.Automation.Mechanical Namespace

AddAcousticFarFieldDirectivity()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldDirectivity()

AddAcousticFarFieldMaximumPressure()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldMaximumPressure()

AddAcousticFarFieldMaximumPressureMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldMaximumPressureMic()

AddAcousticFarFieldMaximumScatteredPressure()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldMaximumScatteredPressure()

AddAcousticFarFieldPhase()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldPhase()

AddAcousticFarFieldPhaseMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldPhaseMic()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1062 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddAcousticFarFieldSoundPowerLevel()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldSoundPowerLevel()

AddAcousticFarFieldSoundPowerLevelWaterfallDiagram()
Creates a new AcousticFarFieldSoundPowerLevelWaterfallDiagram

Declaration Syntax
public virtual AcousticFarFieldSoundPowerLevelWaterfallDiagram AddAcousticFarFieldSoundPower-
LevelWaterfallDiagram()

AddAcousticFarFieldSPL()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldSPL()

AddAcousticFarFieldSPLMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldSPLMic()

AddAcousticFarFieldSPLMicWaterfallDiagram()
Creates a new AcousticFarFieldSPLMicWaterfallDiagram

Declaration Syntax
public virtual AcousticFarFieldSPLMicWaterfallDiagram AddAcousticFarFieldSPLMicWaterfallDiagram()

AddAcousticFarFieldTargetStrength()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldTargetStrength()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1063
Ansys.ACT.Automation.Mechanical Namespace

AddAcousticFrequencyBandAWeightedSPL()
Creates a new AcousticFrequencyBandAWeightedSPL

Declaration Syntax
public virtual AcousticFrequencyBandAWeightedSPL AddAcousticFrequencyBandAWeightedSPL()

AddAcousticFrequencyBandSPL()
Creates a new AcousticFrequencyBandSPL

Declaration Syntax
public virtual AcousticFrequencyBandSPL AddAcousticFrequencyBandSPL()

AddAcousticKineticEnergy()
Creates a new AcousticKineticEnergy

Declaration Syntax
public virtual AcousticKineticEnergy AddAcousticKineticEnergy()

AddAcousticKineticEnergyFrequencyResponse()
Creates a new AcousticKineticEnergyFrequencyResponse

Declaration Syntax
public virtual AcousticKineticEnergyFrequencyResponse AddAcousticKineticEnergyFrequencyResponse()

AddAcousticPotentialEnergy()
Creates a new AcousticPotentialEnergy

Declaration Syntax
public virtual AcousticPotentialEnergy AddAcousticPotentialEnergy()

AddAcousticPotentialEnergyFrequencyResponse()
Creates a new AcousticPotentialEnergyFrequencyResponse

Declaration Syntax
public virtual AcousticPotentialEnergyFrequencyResponse AddAcousticPotentialEnergyFrequencyRe-
sponse()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1064 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddAcousticPressureFrequencyResponse()
Creates a new AcousticPressureFrequencyResponse

Declaration Syntax
public virtual AcousticPressureFrequencyResponse AddAcousticPressureFrequencyResponse()

AddAcousticPressureResult()
Creates a new AcousticPressureResult

Declaration Syntax
public virtual AcousticPressureResult AddAcousticPressureResult()

AddAcousticReturnLoss()
Creates a new AcousticReturnLoss

Declaration Syntax
public virtual AcousticReturnLoss AddAcousticReturnLoss()

AddAcousticSoundPressureLevel()
Creates a new AcousticSoundPressureLevel

Declaration Syntax
public virtual AcousticSoundPressureLevel AddAcousticSoundPressureLevel()

AddAcousticSPLFrequencyResponse()
Creates a new AcousticSPLFrequencyResponse

Declaration Syntax
public virtual AcousticSPLFrequencyResponse AddAcousticSPLFrequencyResponse()

AddAcousticTotalVelocityResult()
Creates a new AcousticTotalVelocityResult

Declaration Syntax
public virtual AcousticTotalVelocityResult AddAcousticTotalVelocityResult()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1065
Ansys.ACT.Automation.Mechanical Namespace

AddAcousticTransmissionLoss()
Creates a new AcousticTransmissionLoss

Declaration Syntax
public virtual AcousticTransmissionLoss AddAcousticTransmissionLoss()

AddAcousticVelocityFrequencyResponse()
Creates a new AcousticVelocityFrequencyResponse

Declaration Syntax
public virtual AcousticVelocityFrequencyResponse AddAcousticVelocityFrequencyResponse()

AddAngularAccelerationProbe()
Creates a new AngularAccelerationProbe

Declaration Syntax
public virtual AngularAccelerationProbe AddAngularAccelerationProbe()

AddAngularVelocityProbe()
Creates a new AngularVelocityProbe

Declaration Syntax
public virtual AngularVelocityProbe AddAngularVelocityProbe()

AddBeamProbe()
Creates a new BeamProbe

Declaration Syntax
public virtual BeamProbe AddBeamProbe()

AddBeamTool()
Creates a new BeamTool

Declaration Syntax
public virtual BeamTool AddBeamTool()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1066 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddBearingProbe()
Creates a new BearingProbe

Declaration Syntax
public virtual BearingProbe AddBearingProbe()

AddBendingStressEquivalent()
Creates a new BendingStressEquivalent

Declaration Syntax
public virtual BendingStressEquivalent AddBendingStressEquivalent()

AddBendingStressIntensity()
Creates a new BendingStressIntensity

Declaration Syntax
public virtual BendingStressIntensity AddBendingStressIntensity()

AddBoltPretensionProbe()
Creates a new BoltPretensionProbe

Declaration Syntax
public virtual BoltPretensionProbe AddBoltPretensionProbe()

AddBoltTool()
Creates a new BoltTool

Declaration Syntax
public virtual BoltTool AddBoltTool()

AddCampbellDiagram()
Creates a new CampbellDiagram

Declaration Syntax
public virtual CampbellDiagram AddCampbellDiagram()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1067
Ansys.ACT.Automation.Mechanical Namespace

AddChargeReactionFrequencyResponse()
Creates a new ChargeReactionFrequencyResponse

Declaration Syntax
public virtual ChargeReactionFrequencyResponse AddChargeReactionFrequencyResponse()

AddChargeReactionProbe()
Creates a new ChargeReactionProbe

Declaration Syntax
public virtual ChargeReactionProbe AddChargeReactionProbe()

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCompositeCriterion()
Creates a new CompositeCriterion

Declaration Syntax
public virtual CompositeCriterion AddCompositeCriterion()

AddCompositeFailureTool()
Creates a new CompositeFailureTool

Declaration Syntax
public virtual CompositeFailureTool AddCompositeFailureTool()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1068 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddCompositeSamplingPointTool()
Creates a new CompositeSamplingPointTool

Declaration Syntax
public virtual CompositeSamplingPointTool AddCompositeSamplingPointTool()

AddContactDistanceProbe()
Creates a new ContactDistanceProbe

Declaration Syntax
public virtual ContactDistanceProbe AddContactDistanceProbe()

AddContactTool()
Creates a new ContactTool

Declaration Syntax
public virtual PostContactTool AddContactTool()

AddCurrentDensity()
Creates a new CurrentDensity

Declaration Syntax
public virtual CurrentDensity AddCurrentDensity()

AddCurrentDensityProbe()
Creates a new CurrentDensityProbe

Declaration Syntax
public virtual CurrentDensityProbe AddCurrentDensityProbe()

AddDamageStatus()
Creates a new DamageStatus

Declaration Syntax
public virtual DamageStatus AddDamageStatus()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1069
Ansys.ACT.Automation.Mechanical Namespace

AddDeformationFrequencyResponse()
Creates a new DeformationFrequencyResponse

Declaration Syntax
public virtual DeformationFrequencyResponse AddDeformationFrequencyResponse()

AddDeformationPhaseResponse()
Creates a new DeformationPhaseResponse

Declaration Syntax
public virtual DeformationPhaseResponse AddDeformationPhaseResponse()

AddDeformationProbe()
Creates a new DeformationProbe

Declaration Syntax
public virtual DeformationProbe AddDeformationProbe()

AddDirectionalAcceleration()
Creates a new DirectionalAcceleration

Declaration Syntax
public virtual DirectionalAcceleration AddDirectionalAcceleration()

AddDirectionalAccelerationPSD()
Creates a new DirectionalAccelerationPSD

Declaration Syntax
public virtual DirectionalAccelerationPSD AddDirectionalAccelerationPSD()

AddDirectionalAccelerationRS()
Creates a new DirectionalAccelerationRS

Declaration Syntax
public virtual DirectionalAccelerationRS AddDirectionalAccelerationRS()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1070 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddDirectionalAxialForce()
Creates a new DirectionalAxialForce

Declaration Syntax
public virtual DirectionalAxialForce AddDirectionalAxialForce()

AddDirectionalBendingMoment()
Creates a new DirectionalBendingMoment

Declaration Syntax
public virtual DirectionalBendingMoment AddDirectionalBendingMoment()

AddDirectionalCurrentDensity()
Creates a new DirectionalCurrentDensity

Declaration Syntax
public virtual DirectionalCurrentDensity AddDirectionalCurrentDensity()

AddDirectionalDeformation()
Creates a new DirectionalDeformation

Declaration Syntax
public virtual DirectionalDeformation AddDirectionalDeformation()

AddDirectionalElectricFieldIntensity()
Creates a new DirectionalElectricFieldIntensity

Declaration Syntax
public virtual DirectionalElectricFieldIntensity AddDirectionalElectricFieldIntensity()

AddDirectionalElectricFluxDensity()
Creates a new DirectionalElectricFluxDensity

Declaration Syntax
public virtual DirectionalElectricFluxDensity AddDirectionalElectricFluxDensity()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1071
Ansys.ACT.Automation.Mechanical Namespace

AddDirectionalElectrostaticForce()
Creates a new DirectionalElectrostaticForce

Declaration Syntax
public virtual DirectionalElectrostaticForce AddDirectionalElectrostaticForce()

AddDirectionalHeatFlux()
Creates a new DirectionalHeatFlux

Declaration Syntax
public virtual DirectionalHeatFlux AddDirectionalHeatFlux()

AddDirectionalMagneticFieldIntensity()
Creates a new DirectionalMagneticFieldIntensity

Declaration Syntax
public virtual DirectionalMagneticFieldIntensity AddDirectionalMagneticFieldIntensity()

AddDirectionalMagneticFluxDensity()
Creates a new DirectionalMagneticFluxDensity

Declaration Syntax
public virtual DirectionalMagneticFluxDensity AddDirectionalMagneticFluxDensity()

AddDirectionalShearForce()
Creates a new DirectionalShearForce

Declaration Syntax
public virtual DirectionalShearForce AddDirectionalShearForce()

AddDirectionalTorsionalMoment()
Creates a new DirectionalTorsionalMoment

Declaration Syntax
public virtual DirectionalTorsionalMoment AddDirectionalTorsionalMoment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1072 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddDirectionalVelocity()
Creates a new DirectionalVelocity

Declaration Syntax
public virtual DirectionalVelocity AddDirectionalVelocity()

AddDirectionalVelocityPSD()
Creates a new DirectionalVelocityPSD

Declaration Syntax
public virtual DirectionalVelocityPSD AddDirectionalVelocityPSD()

AddDirectionalVelocityRS()
Creates a new DirectionalVelocityRS

Declaration Syntax
public virtual DirectionalVelocityRS AddDirectionalVelocityRS()

AddElasticStrainFrequencyResponse()
Creates a new ElasticStrainFrequencyResponse

Declaration Syntax
public virtual ElasticStrainFrequencyResponse AddElasticStrainFrequencyResponse()

AddElasticStrainIntensity()
Creates a new ElasticStrainIntensity

Declaration Syntax
public virtual ElasticStrainIntensity AddElasticStrainIntensity()

AddElasticStrainPhaseResponse()
Creates a new ElasticStrainPhaseResponse

Declaration Syntax
public virtual ElasticStrainPhaseResponse AddElasticStrainPhaseResponse()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1073
Ansys.ACT.Automation.Mechanical Namespace

AddElectricFieldProbe()
Creates a new ElectricFieldProbe

Declaration Syntax
public virtual ElectricFieldProbe AddElectricFieldProbe()

AddElectricPotential()
Creates a new ElectricPotential

Declaration Syntax
public virtual ElectricPotential AddElectricPotential()

AddElectricVoltage()
Creates a new ElectricVoltage

Declaration Syntax
public virtual ElectricVoltage AddElectricVoltage()

AddElectromechanicalCouplingCoefficient()
Creates a new ElectromechanicalCouplingCoefficient

Declaration Syntax
public virtual ElectromechanicalCouplingCoefficient AddElectromechanicalCouplingCoefficient()

AddElementalEulerXYAngle()
Creates a new ElementalEulerXYAngle

Declaration Syntax
public virtual ElementalEulerXYAngle AddElementalEulerXYAngle()

AddElementalEulerXZAngle()
Creates a new ElementalEulerXZAngle

Declaration Syntax
public virtual ElementalEulerXZAngle AddElementalEulerXZAngle()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1074 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddElementalEulerYZAngle()
Creates a new ElementalEulerYZAngle

Declaration Syntax
public virtual ElementalEulerYZAngle AddElementalEulerYZAngle()

AddElementalStrainEnergy()
Creates a new ElementalStrainEnergy

Declaration Syntax
public virtual ElementalStrainEnergy AddElementalStrainEnergy()

AddElementalTriads()
Creates a new ElementalTriads

Declaration Syntax
public virtual ElementalTriads AddElementalTriads()

AddEmagReactionProbe()
Creates a new EmagReactionProbe

Declaration Syntax
public virtual EmagReactionProbe AddEmagReactionProbe()

AddEnergyDissipatedPerUnitVolume()
Creates a new EnergyDissipatedPerUnitVolume

Declaration Syntax
public virtual EnergyDissipatedPerUnitVolume AddEnergyDissipatedPerUnitVolume()

AddEnergyProbe()
Creates a new EnergyProbe

Declaration Syntax
public virtual EnergyProbe AddEnergyProbe()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1075
Ansys.ACT.Automation.Mechanical Namespace

AddEquivalentCreepStrain()
Creates a new EquivalentCreepStrain

Declaration Syntax
public virtual EquivalentCreepStrain AddEquivalentCreepStrain()

AddEquivalentCreepStrainRST()
Creates a new EquivalentCreepStrainRST

Declaration Syntax
public virtual EquivalentCreepStrainRST AddEquivalentCreepStrainRST()

AddEquivalentElasticStrain()
Creates a new EquivalentElasticStrain

Declaration Syntax
public virtual EquivalentElasticStrain AddEquivalentElasticStrain()

AddEquivalentElasticStrainRST()
Creates a new EquivalentElasticStrainRST

Declaration Syntax
public virtual EquivalentElasticStrainRST AddEquivalentElasticStrainRST()

AddEquivalentPlasticStrain()
Creates a new EquivalentPlasticStrain

Declaration Syntax
public virtual EquivalentPlasticStrain AddEquivalentPlasticStrain()

AddEquivalentPlasticStrainRST()
Creates a new EquivalentPlasticStrainRST

Declaration Syntax
public virtual EquivalentPlasticStrainRST AddEquivalentPlasticStrainRST()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1076 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddEquivalentRadiatedPower()
Creates a new EquivalentRadiatedPower

Declaration Syntax
public virtual EquivalentRadiatedPower AddEquivalentRadiatedPower()

AddEquivalentRadiatedPowerLevel()
Creates a new EquivalentRadiatedPowerLevel

Declaration Syntax
public virtual EquivalentRadiatedPowerLevel AddEquivalentRadiatedPowerLevel()

AddEquivalentRadiatedPowerLevelWaterfallDiagram()
Creates a new EquivalentRadiatedPowerLevelWaterfallDiagram

Declaration Syntax
public virtual EquivalentRadiatedPowerLevelWaterfallDiagram AddEquivalentRadiatedPowerLevelWa-
terfallDiagram()

AddEquivalentRadiatedPowerWaterfallDiagram()
Creates a new EquivalentRadiatedPowerWaterfallDiagram

Declaration Syntax
public virtual EquivalentRadiatedPowerWaterfallDiagram AddEquivalentRadiatedPowerWaterfallDia-
gram()

AddEquivalentStress()
Creates a new EquivalentStress

Declaration Syntax
public virtual EquivalentStress AddEquivalentStress()

AddEquivalentStressPSD()
Creates a new EquivalentStressPSD

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1077
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual EquivalentStressPSD AddEquivalentStressPSD()

AddEquivalentStressRS()
Creates a new EquivalentStressRS

Declaration Syntax
public virtual EquivalentStressRS AddEquivalentStressRS()

AddEquivalentTotalStrain()
Creates a new EquivalentTotalStrain

Declaration Syntax
public virtual EquivalentTotalStrain AddEquivalentTotalStrain()

AddExpansionSettings()
Creates a new ExpansionSettings

Declaration Syntax
public virtual ExpansionSettings AddExpansionSettings()

AddFatigueTool()
No details are provided for this entry.

Declaration Syntax
public virtual FatigueTool AddFatigueTool()

AddFiberCompressiveDamageVariable()
Creates a new FiberCompressiveDamageVariable

Declaration Syntax
public virtual FiberCompressiveDamageVariable AddFiberCompressiveDamageVariable()

AddFiberCompressiveFailureCriterion()
Creates a new FiberCompressiveFailureCriterion

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1078 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Declaration Syntax
public virtual FiberCompressiveFailureCriterion AddFiberCompressiveFailureCriterion()

AddFiberTensileDamageVariable()
Creates a new FiberTensileDamageVariable

Declaration Syntax
public virtual FiberTensileDamageVariable AddFiberTensileDamageVariable()

AddFiberTensileFailureCriterion()
Creates a new FiberTensileFailureCriterion

Declaration Syntax
public virtual FiberTensileFailureCriterion AddFiberTensileFailureCriterion()

AddFieldIntensityProbe()
Creates a new FieldIntensityProbe

Declaration Syntax
public virtual FieldIntensityProbe AddFieldIntensityProbe()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddFlexibleRotationProbe()
Creates a new FlexibleRotationProbe

Declaration Syntax
public virtual FlexibleRotationProbe AddFlexibleRotationProbe()

AddFluidFlowRate()
Creates a new FluidFlowRate

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1079
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual FluidFlowRate AddFluidFlowRate()

AddFluidHeatConductionRate()
Creates a new FluidHeatConductionRate

Declaration Syntax
public virtual FluidHeatConductionRate AddFluidHeatConductionRate()

AddFluidHeatTransportRate()
Creates a new FluidHeatTransportRate

Declaration Syntax
public virtual FluidHeatTransportRate AddFluidHeatTransportRate()

AddFluxDensityProbe()
Creates a new FluxDensityProbe

Declaration Syntax
public virtual FluxDensityProbe AddFluxDensityProbe()

AddFluxLinkage()
Creates a new FluxLinkage

Declaration Syntax
public virtual FluxLinkage AddFluxLinkage()

AddForceReaction()
Creates a new ForceReaction

Declaration Syntax
public virtual ForceReaction AddForceReaction()

AddForceReactionFrequencyResponse()
Creates a new ForceReactionFrequencyResponse

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1080 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Declaration Syntax
public virtual ForceReactionFrequencyResponse AddForceReactionFrequencyResponse()

AddForceReactionsForContactRegions(IEnumerable<int>)
Bulk creates Force Reactions for Contact Regions by Contact object Ids

Declaration Syntax
public virtual void AddForceReactionsForContactRegions(IEnumerable<int> contactRegionObjIds)

Parameters
contactRegionObjIds(IEnumerable<int>)

List of the object Ids of the Contact Regions

AddForceSummationProbe()
Creates a new ForceSummationProbe

Declaration Syntax
public virtual ForceSummationProbe AddForceSummationProbe()

AddFractureTool()
Creates a new FractureTool

Declaration Syntax
public virtual FractureTool AddFractureTool()

AddGeneralizedPlaneStrainProbe()
Creates a new GeneralizedPlaneStrainProbe

Declaration Syntax
public virtual GeneralizedPlaneStrainProbe AddGeneralizedPlaneStrainProbe()

AddGroupedScopedACPResults(ResultType, IEnumerable<IDataModelOb-
ject>)
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1081
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void AddGroupedScopedACPResults(ResultType resultType, IEnumerable<IDataMode-
lObject> selectedPlies)

Parameters
resultType(ResultType)

No details are provided for this entry.

selectedPlies(IEnumerable<IDataModelObject>)

No details are provided for this entry.

AddGroupedScopedCustomResult(IEnumerable<IDataModelObject>)
No details are provided for this entry.

Declaration Syntax
public virtual void AddGroupedScopedCustomResult(IEnumerable<IDataModelObject> selectedPlies)

Parameters
selectedPlies(IEnumerable<IDataModelObject>)

No details are provided for this entry.

AddHeatFluxProbe()
Creates a new HeatFluxProbe

Declaration Syntax
public virtual HeatFluxProbe AddHeatFluxProbe()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1082 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImpedanceFrequencyResponse()
Creates a new ImpedanceFrequencyResponse

Declaration Syntax
public virtual ImpedanceFrequencyResponse AddImpedanceFrequencyResponse()

AddImpedanceProbe()
Creates a new ImpedanceProbe

Declaration Syntax
public virtual ImpedanceProbe AddImpedanceProbe()

AddInductance()
Creates a new Inductance

Declaration Syntax
public virtual Inductance AddInductance()

AddJointProbe()
Creates a new JointProbe

Declaration Syntax
public virtual JointProbe AddJointProbe()

AddJouleHeat()
Creates a new JouleHeat

Declaration Syntax
public virtual JouleHeat AddJouleHeat()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1083
Ansys.ACT.Automation.Mechanical Namespace

AddJouleHeatProbe()
Creates a new JouleHeatProbe

Declaration Syntax
public virtual JouleHeatProbe AddJouleHeatProbe()

AddLatticeDensity()
Creates a new LatticeDensity

Declaration Syntax
public virtual LatticeDensity AddLatticeDensity()

AddLatticeElementalDensity()
Creates a new LatticeElementalDensity

Declaration Syntax
public virtual LatticeElementalDensity AddLatticeElementalDensity()

AddLinearizedEquivalentStress()
Creates a new LinearizedEquivalentStress

Declaration Syntax
public virtual LinearizedEquivalentStress AddLinearizedEquivalentStress()

AddLinearizedMaximumPrincipalStress()
Creates a new LinearizedMaximumPrincipalStress

Declaration Syntax
public virtual LinearizedMaximumPrincipalStress AddLinearizedMaximumPrincipalStress()

AddLinearizedMaximumShearStress()
Creates a new LinearizedMaximumShearStress

Declaration Syntax
public virtual LinearizedMaximumShearStress AddLinearizedMaximumShearStress()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1084 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddLinearizedMiddlePrincipalStress()
Creates a new LinearizedMiddlePrincipalStress

Declaration Syntax
public virtual LinearizedMiddlePrincipalStress AddLinearizedMiddlePrincipalStress()

AddLinearizedMinimumPrincipalStress()
Creates a new LinearizedMinimumPrincipalStress

Declaration Syntax
public virtual LinearizedMinimumPrincipalStress AddLinearizedMinimumPrincipalStress()

AddLinearizedNormalStress()
Creates a new LinearizedNormalStress

Declaration Syntax
public virtual LinearizedNormalStress AddLinearizedNormalStress()

AddLinearizedShearStress()
Creates a new LinearizedShearStress

Declaration Syntax
public virtual LinearizedShearStress AddLinearizedShearStress()

AddLinearizedStressIntensity()
Creates a new LinearizedStressIntensity

Declaration Syntax
public virtual LinearizedStressIntensity AddLinearizedStressIntensity()

AddLineChart2D()
Creates a new LineChart2D

Declaration Syntax
public virtual LineChart2D AddLineChart2D()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1085
Ansys.ACT.Automation.Mechanical Namespace

AddLinePressureResult()
Creates a new LinePressureResult

Declaration Syntax
public virtual LinePressureResult AddLinePressureResult()

AddMagneticCoenergy()
Creates a new MagneticCoenergy

Declaration Syntax
public virtual MagneticCoenergy AddMagneticCoenergy()

AddMagneticDirectionalForces()
Creates a new MagneticDirectionalForces

Declaration Syntax
public virtual MagneticDirectionalForces AddMagneticDirectionalForces()

AddMagneticError()
Creates a new MagneticError

Declaration Syntax
public virtual MagneticError AddMagneticError()

AddMagneticFluxProbe()
Creates a new MagneticFluxProbe

Declaration Syntax
public virtual MagneticFluxProbe AddMagneticFluxProbe()

AddMagneticPotential()
Creates a new MagneticPotential

Declaration Syntax
public virtual MagneticPotential AddMagneticPotential()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1086 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddMagneticTotalForces()
Creates a new MagneticTotalForces

Declaration Syntax
public virtual MagneticTotalForces AddMagneticTotalForces()

AddMatrixCompressiveDamageVariable()
Creates a new MatrixCompressiveDamageVariable

Declaration Syntax
public virtual MatrixCompressiveDamageVariable AddMatrixCompressiveDamageVariable()

AddMatrixCompressiveFailureCriterion()
Creates a new MatrixCompressiveFailureCriterion

Declaration Syntax
public virtual MatrixCompressiveFailureCriterion AddMatrixCompressiveFailureCriterion()

AddMatrixTensileDamageVariable()
Creates a new MatrixTensileDamageVariable

Declaration Syntax
public virtual MatrixTensileDamageVariable AddMatrixTensileDamageVariable()

AddMatrixTensileFailureCriterion()
Creates a new MatrixTensileFailureCriterion

Declaration Syntax
public virtual MatrixTensileFailureCriterion AddMatrixTensileFailureCriterion()

AddMaximumFailureCriteria()
Creates a new MaximumFailureCriteria

Declaration Syntax
public virtual MaximumFailureCriteria AddMaximumFailureCriteria()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1087
Ansys.ACT.Automation.Mechanical Namespace

AddMaximumPrincipalElasticStrain()
Creates a new MaximumPrincipalElasticStrain

Declaration Syntax
public virtual MaximumPrincipalElasticStrain AddMaximumPrincipalElasticStrain()

AddMaximumPrincipalStress()
Creates a new MaximumPrincipalStress

Declaration Syntax
public virtual MaximumPrincipalStress AddMaximumPrincipalStress()

AddMaximumPrincipalThermalStrain()
Creates a new MaximumPrincipalThermalStrain

Declaration Syntax
public virtual MaximumPrincipalThermalStrain AddMaximumPrincipalThermalStrain()

AddMaximumShearElasticStrain()
Creates a new MaximumShearElasticStrain

Declaration Syntax
public virtual MaximumShearElasticStrain AddMaximumShearElasticStrain()

AddMaximumShearStress()
Creates a new MaximumShearStress

Declaration Syntax
public virtual MaximumShearStress AddMaximumShearStress()

AddMCFWaterfallDiagram()
Creates a new MCFWaterfallDiagram

Declaration Syntax
public virtual MCFWaterfallDiagram AddMCFWaterfallDiagram()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1088 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddMembraneStressEquivalent()
Creates a new MembraneStressEquivalent

Declaration Syntax
public virtual MembraneStressEquivalent AddMembraneStressEquivalent()

AddMembraneStressIntensity()
Creates a new MembraneStressIntensity

Declaration Syntax
public virtual MembraneStressIntensity AddMembraneStressIntensity()

AddMiddlePrincipalElasticStrain()
Creates a new MiddlePrincipalElasticStrain

Declaration Syntax
public virtual MiddlePrincipalElasticStrain AddMiddlePrincipalElasticStrain()

AddMiddlePrincipalStress()
Creates a new MiddlePrincipalStress

Declaration Syntax
public virtual MiddlePrincipalStress AddMiddlePrincipalStress()

AddMiddlePrincipalThermalStrain()
Creates a new MiddlePrincipalThermalStrain

Declaration Syntax
public virtual MiddlePrincipalThermalStrain AddMiddlePrincipalThermalStrain()

AddMinimumPrincipalElasticStrain()
Creates a new MinimumPrincipalElasticStrain

Declaration Syntax
public virtual MinimumPrincipalElasticStrain AddMinimumPrincipalElasticStrain()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1089
Ansys.ACT.Automation.Mechanical Namespace

AddMinimumPrincipalStress()
Creates a new MinimumPrincipalStress

Declaration Syntax
public virtual MinimumPrincipalStress AddMinimumPrincipalStress()

AddMomentReaction()
Creates a new MomentReaction

Declaration Syntax
public virtual MomentReaction AddMomentReaction()

AddMomentReactionsForContactRegions(IEnumerable<int>)
Bulk creates Moment Reactions for Contact Regions by Contact object Ids

Declaration Syntax
public virtual void AddMomentReactionsForContactRegions(IEnumerable<int> contactRegionObjIds)

Parameters
contactRegionObjIds(IEnumerable<int>)

List of the object Ids of the Contact Regions

AddMullinsDamageVariable()
Creates a new MullinsDamageVariable

Declaration Syntax
public virtual MullinsDamageVariable AddMullinsDamageVariable()

AddMullinsMaximumPreviousStrainEnergy()
Creates a new MullinsMaximumPreviousStrainEnergy

Declaration Syntax
public virtual MullinsMaximumPreviousStrainEnergy AddMullinsMaximumPreviousStrainEnergy()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1090 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddNewtonRaphsonResidualCharge()
Creates a new NewtonRaphsonResidualCharge

Declaration Syntax
public virtual NewtonRaphsonResidualCharge AddNewtonRaphsonResidualCharge()

AddNewtonRaphsonResidualForce()
Creates a new NewtonRaphsonResidualForce

Declaration Syntax
public virtual NewtonRaphsonResidualForce AddNewtonRaphsonResidualForce()

AddNewtonRaphsonResidualHeat()
Creates a new NewtonRaphsonResidualHeat

Declaration Syntax
public virtual NewtonRaphsonResidualHeat AddNewtonRaphsonResidualHeat()

AddNewtonRaphsonResidualMoment()
Creates a new NewtonRaphsonResidualMoment

Declaration Syntax
public virtual NewtonRaphsonResidualMoment AddNewtonRaphsonResidualMoment()

AddNodalEulerXYAngle()
Creates a new NodalEulerXYAngle

Declaration Syntax
public virtual NodalEulerXYAngle AddNodalEulerXYAngle()

AddNodalEulerXZAngle()
Creates a new NodalEulerXZAngle

Declaration Syntax
public virtual NodalEulerXZAngle AddNodalEulerXZAngle()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1091
Ansys.ACT.Automation.Mechanical Namespace

AddNodalEulerYZAngle()
Creates a new NodalEulerYZAngle

Declaration Syntax
public virtual NodalEulerYZAngle AddNodalEulerYZAngle()

AddNodalTriads()
Creates a new NodalTriads

Declaration Syntax
public virtual NodalTriads AddNodalTriads()

AddNormalElasticStrain()
Creates a new NormalElasticStrain

Declaration Syntax
public virtual NormalElasticStrain AddNormalElasticStrain()

AddNormalGasketPressure()
Creates a new NormalGasketPressure

Declaration Syntax
public virtual NormalGasketPressure AddNormalGasketPressure()

AddNormalGasketTotalClosure()
Creates a new NormalGasketTotalClosure

Declaration Syntax
public virtual NormalGasketTotalClosure AddNormalGasketTotalClosure()

AddNormalStress()
Creates a new NormalStress

Declaration Syntax
public virtual NormalStress AddNormalStress()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1092 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddPosition()
Creates a new Position

Declaration Syntax
public virtual Position AddPosition()

AddPrimaryCriterion()
Creates a new PrimaryCriterion

Declaration Syntax
public virtual PrimaryCriterion AddPrimaryCriterion()

AddPythonCodeEventBased()
Creates a new PythonCodeEventBased

Declaration Syntax
public virtual PythonCodeEventBased AddPythonCodeEventBased()

AddPythonResult()
Creates a new PythonResult

Declaration Syntax
public virtual PythonResult AddPythonResult()

AddQualityFactor()
Creates a new QualityFactor

Declaration Syntax
public virtual QualityFactor AddQualityFactor()

AddRadiationProbe()
Creates a new RadiationProbe

Declaration Syntax
public virtual RadiationProbe AddRadiationProbe()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1093
Ansys.ACT.Automation.Mechanical Namespace

AddReactionProbe()
Creates a new ReactionProbe

Declaration Syntax
public virtual ReactionProbe AddReactionProbe()

AddReactionsForContactRegions(IEnumerable<int>)
Bulk creates Reactions for Contact Regions by Contact object Ids

Declaration Syntax
public virtual void AddReactionsForContactRegions(IEnumerable<int> contactRegionObjIds)

Parameters
contactRegionObjIds(IEnumerable<int>)

List of the object Ids of the Contact Regions

AddResponsePSD()
Creates a new ResponsePSD

Declaration Syntax
public virtual ResponsePSD AddResponsePSD()

AddResponsePSDTool()
Creates a new ResponsePSDTool

Declaration Syntax
public virtual ResponsePSDTool AddResponsePSDTool()

AddResultMesh()
Creates a new ResultMesh

Declaration Syntax
public virtual ResultMesh AddResultMesh()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1094 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddRotationProbe()
Creates a new RotationProbe

Declaration Syntax
public virtual RotationProbe AddRotationProbe()

AddShapeFinder()
Creates a new ShapeFinder

Declaration Syntax
public virtual ShapeFinder AddShapeFinder()

AddShapeFinderElemental()
Creates a new ShapeFinderElemental

Declaration Syntax
public virtual ShapeFinderElemental AddShapeFinderElemental()

AddShearDamageVariable()
Creates a new ShearDamageVariable

Declaration Syntax
public virtual ShearDamageVariable AddShearDamageVariable()

AddShearElasticStrain()
Creates a new ShearElasticStrain

Declaration Syntax
public virtual ShearElasticStrain AddShearElasticStrain()

AddShearGasketPressure()
Creates a new ShearGasketPressure

Declaration Syntax
public virtual ShearGasketPressure AddShearGasketPressure()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1095
Ansys.ACT.Automation.Mechanical Namespace

AddShearGasketTotalClosure()
Creates a new ShearGasketTotalClosure

Declaration Syntax
public virtual ShearGasketTotalClosure AddShearGasketTotalClosure()

AddShearMomentDiagramMSUM()
Creates a new TotalShearMomentDiagram

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramMSUM()

AddShearMomentDiagramMY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramMY()

AddShearMomentDiagramMZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramMZ()

AddShearMomentDiagramUSUM()
Creates a new TotalShearMomentDiagram

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramUSUM()

AddShearMomentDiagramUY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramUY()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1096 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddShearMomentDiagramUZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramUZ()

AddShearMomentDiagramVSUM()
Creates a new TotalShearMomentDiagram

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramVSUM()

AddShearMomentDiagramVY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVY()

AddShearMomentDiagramVZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVZ()

AddShearStress()
Creates a new ShearStress

Declaration Syntax
public virtual ShearStress AddShearStress()

AddShellBendingStress()
Creates a new ShellBendingStress

Declaration Syntax
public virtual ShellBendingStress AddShellBendingStress()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1097
Ansys.ACT.Automation.Mechanical Namespace

AddShellBottomPeakStress()
Creates a new ShellBottomPeakStress

Declaration Syntax
public virtual ShellBottomPeakStress AddShellBottomPeakStress()

AddShellMembraneStress()
Creates a new ShellMembraneStress

Declaration Syntax
public virtual ShellMembraneStress AddShellMembraneStress()

AddShellTopPeakStress()
Creates a new ShellTopPeakStress

Declaration Syntax
public virtual ShellTopPeakStress AddShellTopPeakStress()

AddSpringProbe()
Creates a new SpringProbe

Declaration Syntax
public virtual SpringProbe AddSpringProbe()

AddStabilizationEnergy()
Creates a new StabilizationEnergy

Declaration Syntax
public virtual StabilizationEnergy AddStabilizationEnergy()

AddStrainProbe()
Creates a new StrainProbe

Declaration Syntax
public virtual StrainProbe AddStrainProbe()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1098 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddStressFrequencyResponse()
Creates a new StressFrequencyResponse

Declaration Syntax
public virtual StressFrequencyResponse AddStressFrequencyResponse()

AddStressIntensity()
Creates a new StressIntensity

Declaration Syntax
public virtual StressIntensity AddStressIntensity()

AddStressPhaseResponse()
Creates a new StressPhaseResponse

Declaration Syntax
public virtual StressPhaseResponse AddStressPhaseResponse()

AddStressProbe()
Creates a new StressProbe

Declaration Syntax
public virtual StressProbe AddStressProbe()

AddStressTool()
Creates a new StressTool

Declaration Syntax
public virtual StressTool AddStressTool()

AddStructuralError()
Creates a new StructuralError

Declaration Syntax
public virtual StructuralError AddStructuralError()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1099
Ansys.ACT.Automation.Mechanical Namespace

AddStructuralStrainEnergy()
Creates a new StructuralStrainEnergy

Declaration Syntax
public virtual StructuralStrainEnergy AddStructuralStrainEnergy()

AddTemperature()
Creates a new TemperatureResult

Declaration Syntax
public virtual TemperatureResult AddTemperature()

AddTemperatureProbe()
Creates a new TemperatureProbe

Declaration Syntax
public virtual TemperatureProbe AddTemperatureProbe()

AddThermalError()
Creates a new ThermalError

Declaration Syntax
public virtual ThermalError AddThermalError()

AddThermalStrain()
Creates a new DirectionalThermalStrain

Declaration Syntax
public virtual DirectionalThermalStrain AddThermalStrain()

AddThermalStrainEnergy()
Creates a new ThermalStrainEnergy

Declaration Syntax
public virtual ThermalStrainEnergy AddThermalStrainEnergy()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1100 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddTopologyDensity()
Creates a new TopologyDensity

Declaration Syntax
public virtual TopologyDensity AddTopologyDensity()

AddTopologyElementalDensity()
Creates a new TopologyElementalDensity

Declaration Syntax
public virtual TopologyElementalDensity AddTopologyElementalDensity()

AddTorqueProbe()
Creates a new TorqueProbe

Declaration Syntax
public virtual TorqueProbe AddTorqueProbe()

AddTotalAcceleration()
Creates a new TotalAcceleration

Declaration Syntax
public virtual TotalAcceleration AddTotalAcceleration()

AddTotalAxialForce()
Creates a new TotalAxialForce

Declaration Syntax
public virtual TotalAxialForce AddTotalAxialForce()

AddTotalBendingMoment()
Creates a new TotalBendingMoment

Declaration Syntax
public virtual TotalBendingMoment AddTotalBendingMoment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1101
Ansys.ACT.Automation.Mechanical Namespace

AddTotalCurrentDensity()
Creates a new TotalCurrentDensity

Declaration Syntax
public virtual TotalCurrentDensity AddTotalCurrentDensity()

AddTotalDeformation()
Creates a new TotalDeformation

Declaration Syntax
public virtual TotalDeformation AddTotalDeformation()

AddTotalElectricFieldIntensity()
Creates a new TotalElectricFieldIntensity

Declaration Syntax
public virtual TotalElectricFieldIntensity AddTotalElectricFieldIntensity()

AddTotalElectricFluxDensity()
Creates a new TotalElectricFluxDensity

Declaration Syntax
public virtual TotalElectricFluxDensity AddTotalElectricFluxDensity()

AddTotalElectrostaticForce()
Creates a new TotalElectrostaticForce

Declaration Syntax
public virtual TotalElectrostaticForce AddTotalElectrostaticForce()

AddTotalHeatFlux()
Creates a new TotalHeatFlux

Declaration Syntax
public virtual TotalHeatFlux AddTotalHeatFlux()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1102 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddTotalMagneticFieldIntensity()
Creates a new TotalMagneticFieldIntensity

Declaration Syntax
public virtual TotalMagneticFieldIntensity AddTotalMagneticFieldIntensity()

AddTotalMagneticFluxDensity()
Creates a new TotalMagneticFluxDensity

Declaration Syntax
public virtual TotalMagneticFluxDensity AddTotalMagneticFluxDensity()

AddTotalShearForce()
Creates a new TotalShearForce

Declaration Syntax
public virtual TotalShearForce AddTotalShearForce()

AddTotalTorsionalMoment()
Creates a new TotalTorsionalMoment

Declaration Syntax
public virtual TotalTorsionalMoment AddTotalTorsionalMoment()

AddTotalVelocity()
Creates a new TotalVelocity

Declaration Syntax
public virtual TotalVelocity AddTotalVelocity()

AddUserDefinedResult()
Creates a new UserDefinedResult

Declaration Syntax
public virtual UserDefinedResult AddUserDefinedResult()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1103
Ansys.ACT.Automation.Mechanical Namespace

AddVariableGraph()
Creates a new VariableGraph

Declaration Syntax
public virtual VariableGraph AddVariableGraph()

AddVectorAxialForce()
Creates a new VectorAxialForce

Declaration Syntax
public virtual VectorAxialForce AddVectorAxialForce()

AddVectorBendingMoment()
Creates a new VectorBendingMoment

Declaration Syntax
public virtual VectorBendingMoment AddVectorBendingMoment()

AddVectorDeformation()
Creates a new VectorDeformation

Declaration Syntax
public virtual VectorDeformation AddVectorDeformation()

AddVectorHeatFlux()
Creates a new VectorHeatFlux

Declaration Syntax
public virtual VectorHeatFlux AddVectorHeatFlux()

AddVectorPrincipalElasticStrain()
Creates a new VectorPrincipalElasticStrain

Declaration Syntax
public virtual VectorPrincipalElasticStrain AddVectorPrincipalElasticStrain()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1104 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

AddVectorPrincipalStress()
Creates a new VectorPrincipalStress

Declaration Syntax
public virtual VectorPrincipalStress AddVectorPrincipalStress()

AddVectorShearForce()
Creates a new VectorShearForce

Declaration Syntax
public virtual VectorShearForce AddVectorShearForce()

AddVectorTorsionalMoment()
Creates a new VectorTorsionalMoment

Declaration Syntax
public virtual VectorTorsionalMoment AddVectorTorsionalMoment()

AddVelocityFrequencyResponse()
Creates a new VelocityFrequencyResponse

Declaration Syntax
public virtual VelocityFrequencyResponse AddVelocityFrequencyResponse()

AddVelocityPhaseResponse()
Creates a new VelocityPhaseResponse

Declaration Syntax
public virtual VelocityPhaseResponse AddVelocityPhaseResponse()

AddVelocityProbe()
Creates a new VelocityProbe

Declaration Syntax
public virtual VelocityProbe AddVelocityProbe()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1105
Ansys.ACT.Automation.Mechanical Namespace

AddVelocityWaterfallDiagram()
Creates a new VelocityWaterfallDiagram

Declaration Syntax
public virtual VelocityWaterfallDiagram AddVelocityWaterfallDiagram()

AddVoltageFrequencyResponse()
Creates a new VoltageFrequencyResponse

Declaration Syntax
public virtual VoltageFrequencyResponse AddVoltageFrequencyResponse()

AddVoltageProbe()
Creates a new ElectricVoltageProbe

Declaration Syntax
public virtual ElectricVoltageProbe AddVoltageProbe()

AddVolume()
Creates a new Volume

Declaration Syntax
public virtual Volume AddVolume()

AddVolumeProbe()
Creates a new VolumeProbe

Declaration Syntax
public virtual VolumeProbe AddVolumeProbe()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1106 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

ClearRemoteStorageData()
No details are provided for this entry.

Declaration Syntax
public virtual void ClearRemoteStorageData()

CreateResultsAtAllSets(uint)
No details are provided for this entry.

Declaration Syntax
public virtual List<IDataModelObject> CreateResultsAtAllSets(uint resId)

Parameters
resId(uint)

No details are provided for this entry.

DeleteRow(uint)
No details are provided for this entry.

Declaration Syntax
public virtual void DeleteRow(uint index)

Parameters
index(uint)

No details are provided for this entry.

DisconnectRemoteJob()
No details are provided for this entry.

Declaration Syntax
public virtual void DisconnectRemoteJob()

EvaluateAllContactTrackers()
No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1107
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void EvaluateAllContactTrackers()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

EvaluateContactTracker()
No details are provided for this entry.

Declaration Syntax
public virtual void EvaluateContactTracker()

ExecutePostCommands()
Run Execute Post Commands for all post command objects.

Declaration Syntax
public virtual void ExecutePostCommands()

ExecutePostCommands(IEnumerable<IDataModelObject>)
Run Execute Post Commands for specified post commands objects.

Declaration Syntax
public virtual void ExecutePostCommands(IEnumerable<IDataModelObject> activeObjs)

Parameters
activeObjs(IEnumerable<IDataModelObject>)

List of the command snippet objects.

ExportSubstructure(string, ExportFormat, ExportSettings)


Export Substructure to cpa file.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1108 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

Declaration Syntax
public virtual void ExportSubstructure(string exportFileName, ExportFormat exportFormat, ExportSet-
tings exportSettings)

Parameters
exportFileName(string)

File path for the cpa file to be exported

exportFormat(ExportFormat)

The format to use when exporting.

exportSettings(ExportSettings)

The settings to use when exporting.

ExtractSolutionStatistics()
No details are provided for this entry.

Declaration Syntax
public virtual void ExtractSolutionStatistics()

FetchRemoteResults()
No details are provided for this entry.

Declaration Syntax
public virtual void FetchRemoteResults()

FormatValue(double, int)
No details are provided for this entry.

Declaration Syntax
public virtual string FormatValue(double value, int unitType)

Parameters
value(double)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1109
Ansys.ACT.Automation.Mechanical Namespace

unitType(int)

No details are provided for this entry.

GenerateAdaptedMesh()
No details are provided for this entry.

Declaration Syntax
public virtual void GenerateAdaptedMesh()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1110 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetResults()
Gets the Results from the server.

Declaration Syntax
public virtual void GetResults()

IsResultFileChanged()
Checks if the referenced result file has been changed.

Declaration Syntax
public virtual bool IsResultFileChanged()

IsResultFileSameAsLoaded(string)
Checks if the given result file is same the loaded result file

Declaration Syntax
public virtual bool IsResultFileSameAsLoaded(string filepath)

Parameters
filepath(string)

No details are provided for this entry.

OpenSolverFilesDirectory()
Run the OpenSolverFilesDirectory action.

Declaration Syntax
public virtual void OpenSolverFilesDirectory()

ReadAnsysResultFile()
Run the Ansys ReadResults action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1111
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void ReadAnsysResultFile()

ReadGivenAnsysResultFile(string, UnitSystemIDType)
Run the given Ansys ReadResults action.///

Declaration Syntax
public virtual void ReadGivenAnsysResultFile(string resultFilePath, UnitSystemIDType unitSystemID)

Parameters
resultFilePath(string)

The Filepath to a compatable Ansys results file

unitSystemID(UnitSystemIDType)

The unit system ID as defined in Ansys.Mechanical.DataModel.Enums.UnitSystemIDType

ReadGivenAnsysResultFileByReference(string, UnitSystemIDType)
Run the given Ansys ReadResults by reference action.///

Declaration Syntax
public virtual void ReadGivenAnsysResultFileByReference(string resultFilePath, UnitSystemIDType
unitSystemID)

Parameters
resultFilePath(string)

The Filepath to a compatable Ansys results file

unitSystemID(UnitSystemIDType)

The unit system ID as defined in Ansys.Mechanical.DataModel.Enums.UnitSystemIDType

ReconnectRemoteJob()
No details are provided for this entry.

Declaration Syntax
public virtual void ReconnectRemoteJob()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1112 of ANSYS, Inc. and its subsidiaries and affiliates.
Solution

RelinkResultFile(string)
Relink the result file. This action allows repairing the result file referencing without altering the gen-
erated result data.

Declaration Syntax
public virtual void RelinkResultFile(string filepath)

Parameters
filepath(string)

No details are provided for this entry.

ReloadResultFile()
Reload the result file. For results-only systems, this action reloads the result mesh data and resets all
result scopings.

Declaration Syntax
public virtual void ReloadResultFile()

Solve(bool, SolveConfiguration)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, SolveConfiguration config)

Parameters
wait(bool)

Wait or not for the solve to be done.

config(SolveConfiguration)

The solve configuration to use. If null, the default.

Solve(bool, string)
Run the Solve action.

Declaration Syntax
public virtual void Solve(bool wait, string config)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1113
Ansys.ACT.Automation.Mechanical Namespace

Parameters
wait(bool)

Wait or not for the solve to be done.

config(string)

The solve configuration to use. Will throw an error if the input solve configuration does not exist.
If none is provided, the default is used for the solve.

ValueForResultTracking(uint, string)
No details are provided for this entry.

Declaration Syntax
public virtual string ValueForResultTracking(uint index, string key)

Parameters
index(uint)

No details are provided for this entry.

key(string)

No details are provided for this entry.

ValueForSolutionTracking(uint, string)
No details are provided for this entry.

Declaration Syntax
public virtual string ValueForSolutionTracking(uint index, string key)

Parameters
index(uint)

No details are provided for this entry.

key(string)

No details are provided for this entry.

SolutionCombination
Defines a SolutionCombination.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1114 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public class SolutionCombination : DataModelObject, IEvaluateAllResults, IFolderDataModelObject

Table 334: Members

Property Children (p. 1117) Gets the list of children.


Property Comments (p. 1117) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1117) Gets the current DataModelObject's category.
Property Definition (p. 1117) Get the SolutionCombinationDefinition object. This object co
Combination data like Base Cases, Load Combinations and Co
Property EnvelopeType (p. 1117) Gets or sets the Envelope Type. Default: (See
Ansys.Mechanical.DataModel.MechanicalEnums.SolutionComb
Property Images (p. 1118) Gets the list of associated images.
Property InternalObject (p. 1118) Gets the internal object. For advanced usage only.
Property Type (p. 1118) Gets or sets the Solution Combination Type. Default: (See
Ansys.Mechanical.DataModel.MechanicalEnums.SolutionComb
Method AddBeamTool() (p. 1118) Creates a new BeamTool
Method AddComment() (p. 1118) Creates a new child Comment.
Method AddCompositeFailureTool() (p. 1118) Creates a new CompositeFailureTool
Method AddContactTool() (p. 1119) Creates a new ContactTool
Method AddDirectionalAcceleration() (p. 1119) Creates a new DirectionalAcceleration
Method AddDirectionalAxialForce() (p. 1119) Creates a new DirectionalAxialForce
Method AddDirectionalBendingMoment() (p. 1119) Creates a new DirectionalBendingMoment
Method AddDirectionalDeformation() (p. 1119) Creates a new DirectionalDeformation
Method AddDirectionalShearForce() (p. 1119) Creates a new DirectionalShearForce
Method AddDirectionalTorsionalMoment() (p. 1120) Creates a new DirectionalTorsionalMoment
Method AddDirectionalVelocity() (p. 1120) Creates a new DirectionalVelocity
Method AddElasticStrainIntensity() (p. 1120) Creates a new ElasticStrainIntensity
Method AddEquivalentElasticStrain() (p. 1120) Creates a new EquivalentElasticStrain
Method AddEquivalentElasticStrainRST() (p. 1120) Creates a new EquivalentElasticStrainRST
Method AddEquivalentStress() (p. 1120) Creates a new EquivalentStress
Method AddEquivalentTotalStrain() (p. 1121) Creates a new EquivalentTotalStrain
Method AddFatigueTool() (p. 1121) Creates a new FatigueTool
Method AddImage(string) (p. 1121) Creates a new child Image. If a filePath is provided, the image
file, if not, the image will be a screen capture of the Geometr
Method AddLinearizedEquivalentStress() (p. 1121) Creates a new LinearizedEquivalentStress
Method AddLinearizedMaximumPrincipalStress() (p. 1121)Creates a new LinearizedMaximumPrincipalStress
Method AddLinearizedMaximumShearStress() (p. 1122) Creates a new LinearizedMaximumShearStress
Method AddLinearizedMiddlePrincipalStress() (p. 1122) Creates a new LinearizedMiddlePrincipalStress
Method AddLinearizedMinimumPrincipalStress() (p. 1122)Creates a new LinearizedMinimumPrincipalStress

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1115
Ansys.ACT.Automation.Mechanical Namespace

Method AddLinearizedNormalStress() (p. 1122) Creates a new LinearizedNormalStress


Method AddLinearizedShearStress() (p. 1122) Creates a new LinearizedShearStress
Method AddLinearizedStressIntensity() (p. 1122) Creates a new LinearizedStressIntensity
Method AddMaximumPrincipalElasticStrain() (p. 1123) Creates a new MaximumPrincipalElasticStrain
Method AddMaximumPrincipalStress() (p. 1123) Creates a new MaximumPrincipalStress
Method AddMaximumShearElasticStrain() (p. 1123) Creates a new MaximumShearElasticStrain
Method AddMaximumShearStress() (p. 1123) Creates a new MaximumShearStress
Method AddMiddlePrincipalElasticStrain() (p. 1123) Creates a new MiddlePrincipalElasticStrain
Method AddMiddlePrincipalStress() (p. 1123) Creates a new MiddlePrincipalStress
Method AddMinimumPrincipalElasticStrain() (p. 1124) Creates a new MinimumPrincipalElasticStrain
Method AddMinimumPrincipalStress() (p. 1124) Creates a new MinimumPrincipalStress
Method AddNormalElasticStrain() (p. 1124) Creates a new NormalElasticStrain
Method AddNormalStress() (p. 1124) Creates a new NormalStress
Method AddShearElasticStrain() (p. 1124) Creates a new ShearElasticStrain
Method AddShearMomentDiagramMSUM() (p. 1124) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramMY() (p. 1125) Creates a new DirectionalShearMomentDiagram
Method AddShearMomentDiagramMZ() (p. 1125) Creates a new DirectionalShearMomentDiagram
Method AddShearMomentDiagramUSUM() (p. 1125) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramUY() (p. 1125) Creates a new DirectionalShearMomentDiagram
Method AddShearMomentDiagramUZ() (p. 1125) Creates a new DirectionalShearMomentDiagram
Method AddShearMomentDiagramVSUM() (p. 1125) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramVY() (p. 1126) Creates a new DirectionalShearMomentDiagram
Method AddShearMomentDiagramVZ() (p. 1126) Creates a new DirectionalShearMomentDiagram
Method AddShearStress() (p. 1126) Creates a new ShearStress
Method AddStressIntensity() (p. 1126) Creates a new StressIntensity
Method AddStressTool() (p. 1126) Creates a new StressTool
Method AddTotalAcceleration() (p. 1126) Creates a new TotalAcceleration
Method AddTotalAxialForce() (p. 1127) Creates a new TotalAxialForce
Method AddTotalBendingMoment() (p. 1127) Creates a new TotalBendingMoment
Method AddTotalDeformation() (p. 1127) Creates a new TotalDeformation
Method AddTotalShearForce() (p. 1127) Creates a new TotalShearForce
Method AddTotalTorsionalMoment() (p. 1127) Creates a new TotalTorsionalMoment
Method AddTotalVelocity() (p. 1127) Creates a new TotalVelocity
Method AddUserDefinedResult() (p. 1128) Creates a new UserDefinedResult
Method AddVectorAxialForce() (p. 1128) Creates a new VectorAxialForce
Method AddVectorBendingMoment() (p. 1128) Creates a new VectorBendingMoment
Method AddVectorPrincipalElasticStrain() (p. 1128) Creates a new VectorPrincipalElasticStrain
Method AddVectorPrincipalStress() (p. 1128) Creates a new VectorPrincipalStress
Method AddVectorShearForce() (p. 1128) Creates a new VectorShearForce

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1116 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Method AddVectorTorsionalMoment() (p. 1129) Creates a new VectorTorsionalMoment


Method ClearGeneratedData() (p. 1129) Run the ClearGeneratedData action.
Method Delete() (p. 1129) Run the Delete action.
Method EvaluateAllResults() (p. 1129) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1129)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1130)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Definition
Get the SolutionCombinationDefinition object. This object contains all the Solution Combination data
like Base Cases, Load Combinations and Coefficients.

Declaration Syntax
public SolutionCombinationDefinition Definition { get; }

EnvelopeType
Gets or sets the Envelope Type. Default: (See Ansys.Mechanical.DataModel.MechanicalEnums.Solution-
Combination.EnvelopeType.Maximum)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1117
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public EnvelopeType EnvelopeType { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSolutionCombinationAuto InternalObject { get; }

Type
Gets or sets the Solution Combination Type. Default: (See Ansys.Mechanical.DataModel.MechanicalEn-
ums.SolutionCombination.Type.LoadCombinations)

Declaration Syntax
public Type Type { set;get; }

AddBeamTool()
Creates a new BeamTool

Declaration Syntax
public virtual BeamTool AddBeamTool()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCompositeFailureTool()
Creates a new CompositeFailureTool

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1118 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual CompositeFailureTool AddCompositeFailureTool()

AddContactTool()
Creates a new ContactTool

Declaration Syntax
public virtual PostContactTool AddContactTool()

AddDirectionalAcceleration()
Creates a new DirectionalAcceleration

Declaration Syntax
public virtual DirectionalAcceleration AddDirectionalAcceleration()

AddDirectionalAxialForce()
Creates a new DirectionalAxialForce

Declaration Syntax
public virtual DirectionalAxialForce AddDirectionalAxialForce()

AddDirectionalBendingMoment()
Creates a new DirectionalBendingMoment

Declaration Syntax
public virtual DirectionalBendingMoment AddDirectionalBendingMoment()

AddDirectionalDeformation()
Creates a new DirectionalDeformation

Declaration Syntax
public virtual DirectionalDeformation AddDirectionalDeformation()

AddDirectionalShearForce()
Creates a new DirectionalShearForce

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1119
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual DirectionalShearForce AddDirectionalShearForce()

AddDirectionalTorsionalMoment()
Creates a new DirectionalTorsionalMoment

Declaration Syntax
public virtual DirectionalTorsionalMoment AddDirectionalTorsionalMoment()

AddDirectionalVelocity()
Creates a new DirectionalVelocity

Declaration Syntax
public virtual DirectionalVelocity AddDirectionalVelocity()

AddElasticStrainIntensity()
Creates a new ElasticStrainIntensity

Declaration Syntax
public virtual ElasticStrainIntensity AddElasticStrainIntensity()

AddEquivalentElasticStrain()
Creates a new EquivalentElasticStrain

Declaration Syntax
public virtual EquivalentElasticStrain AddEquivalentElasticStrain()

AddEquivalentElasticStrainRST()
Creates a new EquivalentElasticStrainRST

Declaration Syntax
public virtual EquivalentElasticStrainRST AddEquivalentElasticStrainRST()

AddEquivalentStress()
Creates a new EquivalentStress

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1120 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual EquivalentStress AddEquivalentStress()

AddEquivalentTotalStrain()
Creates a new EquivalentTotalStrain

Declaration Syntax
public virtual EquivalentTotalStrain AddEquivalentTotalStrain()

AddFatigueTool()
Creates a new FatigueTool

Declaration Syntax
public virtual FatigueTool AddFatigueTool()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddLinearizedEquivalentStress()
Creates a new LinearizedEquivalentStress

Declaration Syntax
public virtual LinearizedEquivalentStress AddLinearizedEquivalentStress()

AddLinearizedMaximumPrincipalStress()
Creates a new LinearizedMaximumPrincipalStress

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1121
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual LinearizedMaximumPrincipalStress AddLinearizedMaximumPrincipalStress()

AddLinearizedMaximumShearStress()
Creates a new LinearizedMaximumShearStress

Declaration Syntax
public virtual LinearizedMaximumShearStress AddLinearizedMaximumShearStress()

AddLinearizedMiddlePrincipalStress()
Creates a new LinearizedMiddlePrincipalStress

Declaration Syntax
public virtual LinearizedMiddlePrincipalStress AddLinearizedMiddlePrincipalStress()

AddLinearizedMinimumPrincipalStress()
Creates a new LinearizedMinimumPrincipalStress

Declaration Syntax
public virtual LinearizedMinimumPrincipalStress AddLinearizedMinimumPrincipalStress()

AddLinearizedNormalStress()
Creates a new LinearizedNormalStress

Declaration Syntax
public virtual LinearizedNormalStress AddLinearizedNormalStress()

AddLinearizedShearStress()
Creates a new LinearizedShearStress

Declaration Syntax
public virtual LinearizedShearStress AddLinearizedShearStress()

AddLinearizedStressIntensity()
Creates a new LinearizedStressIntensity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1122 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual LinearizedStressIntensity AddLinearizedStressIntensity()

AddMaximumPrincipalElasticStrain()
Creates a new MaximumPrincipalElasticStrain

Declaration Syntax
public virtual MaximumPrincipalElasticStrain AddMaximumPrincipalElasticStrain()

AddMaximumPrincipalStress()
Creates a new MaximumPrincipalStress

Declaration Syntax
public virtual MaximumPrincipalStress AddMaximumPrincipalStress()

AddMaximumShearElasticStrain()
Creates a new MaximumShearElasticStrain

Declaration Syntax
public virtual MaximumShearElasticStrain AddMaximumShearElasticStrain()

AddMaximumShearStress()
Creates a new MaximumShearStress

Declaration Syntax
public virtual MaximumShearStress AddMaximumShearStress()

AddMiddlePrincipalElasticStrain()
Creates a new MiddlePrincipalElasticStrain

Declaration Syntax
public virtual MiddlePrincipalElasticStrain AddMiddlePrincipalElasticStrain()

AddMiddlePrincipalStress()
Creates a new MiddlePrincipalStress

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1123
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual MiddlePrincipalStress AddMiddlePrincipalStress()

AddMinimumPrincipalElasticStrain()
Creates a new MinimumPrincipalElasticStrain

Declaration Syntax
public virtual MinimumPrincipalElasticStrain AddMinimumPrincipalElasticStrain()

AddMinimumPrincipalStress()
Creates a new MinimumPrincipalStress

Declaration Syntax
public virtual MinimumPrincipalStress AddMinimumPrincipalStress()

AddNormalElasticStrain()
Creates a new NormalElasticStrain

Declaration Syntax
public virtual NormalElasticStrain AddNormalElasticStrain()

AddNormalStress()
Creates a new NormalStress

Declaration Syntax
public virtual NormalStress AddNormalStress()

AddShearElasticStrain()
Creates a new ShearElasticStrain

Declaration Syntax
public virtual ShearElasticStrain AddShearElasticStrain()

AddShearMomentDiagramMSUM()
Creates a new TotalShearMomentDiagram

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1124 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramMSUM()

AddShearMomentDiagramMY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramMY()

AddShearMomentDiagramMZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramMZ()

AddShearMomentDiagramUSUM()
Creates a new TotalShearMomentDiagram

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramUSUM()

AddShearMomentDiagramUY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramUY()

AddShearMomentDiagramUZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramUZ()

AddShearMomentDiagramVSUM()
Creates a new TotalShearMomentDiagram

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1125
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramVSUM()

AddShearMomentDiagramVY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVY()

AddShearMomentDiagramVZ()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVZ()

AddShearStress()
Creates a new ShearStress

Declaration Syntax
public virtual ShearStress AddShearStress()

AddStressIntensity()
Creates a new StressIntensity

Declaration Syntax
public virtual StressIntensity AddStressIntensity()

AddStressTool()
Creates a new StressTool

Declaration Syntax
public virtual StressTool AddStressTool()

AddTotalAcceleration()
Creates a new TotalAcceleration

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1126 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual TotalAcceleration AddTotalAcceleration()

AddTotalAxialForce()
Creates a new TotalAxialForce

Declaration Syntax
public virtual TotalAxialForce AddTotalAxialForce()

AddTotalBendingMoment()
Creates a new TotalBendingMoment

Declaration Syntax
public virtual TotalBendingMoment AddTotalBendingMoment()

AddTotalDeformation()
Creates a new TotalDeformation

Declaration Syntax
public virtual TotalDeformation AddTotalDeformation()

AddTotalShearForce()
Creates a new TotalShearForce

Declaration Syntax
public virtual TotalShearForce AddTotalShearForce()

AddTotalTorsionalMoment()
Creates a new TotalTorsionalMoment

Declaration Syntax
public virtual TotalTorsionalMoment AddTotalTorsionalMoment()

AddTotalVelocity()
Creates a new TotalVelocity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1127
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual TotalVelocity AddTotalVelocity()

AddUserDefinedResult()
Creates a new UserDefinedResult

Declaration Syntax
public virtual UserDefinedResult AddUserDefinedResult()

AddVectorAxialForce()
Creates a new VectorAxialForce

Declaration Syntax
public virtual VectorAxialForce AddVectorAxialForce()

AddVectorBendingMoment()
Creates a new VectorBendingMoment

Declaration Syntax
public virtual VectorBendingMoment AddVectorBendingMoment()

AddVectorPrincipalElasticStrain()
Creates a new VectorPrincipalElasticStrain

Declaration Syntax
public virtual VectorPrincipalElasticStrain AddVectorPrincipalElasticStrain()

AddVectorPrincipalStress()
Creates a new VectorPrincipalStress

Declaration Syntax
public virtual VectorPrincipalStress AddVectorPrincipalStress()

AddVectorShearForce()
Creates a new VectorShearForce

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1128 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombination

Declaration Syntax
public virtual VectorShearForce AddVectorShearForce()

AddVectorTorsionalMoment()
Creates a new VectorTorsionalMoment

Declaration Syntax
public virtual VectorTorsionalMoment AddVectorTorsionalMoment()

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1129
Ansys.ACT.Automation.Mechanical Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

SolutionCombinationDefinition
No details are provided for this entry.

Declaration Syntax
public class SolutionCombinationDefinition

Table 335: Members

Property BaseCaseCount (p. 1131) Gets the number of bases cases


Property LoadCombinationCount (p. 1132) Gets the number of load combinations
Method AddBaseCase(string, Analysis, Add a BaseCase to the
double) (p. 1132) SolutionCombinationDefinition

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1130 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

Method AddLoadCombination(string, Add a LoadCombination to the SolutionCombination


int) (p. 1132) Definition
Method DeleteBaseCase(int) (p. 1133) Delete a BaseCase from the
SolutionCombinationDefinition
Method DeleteLoadCombination(int) (p. 1133) Delete a LoadCombination from the
SolutionCombination Definition
Method Export(string) (p. 1133) Export Load Combination Definition data to Comma
Separated Value (CSV) files
Method GetBaseCaseAnalysis(int) (p. 1133) Gets the BaseCase Analysis property at given index.
Method GetBaseCaseFrequency(int) (p. 1134) Gets the Frequency property from the Base Case at
given index
Method GetBaseCaseName(int) (p. 1134) Gets the BaseCase Name property at given index
Method GetBaseCasePhaseAngle(int) (p. 1134) Gets the Phase Angle property from the Base Case
at given index
Method GetBaseCaseTime(int) (p. 1135) Gets the Time property from the Base Case at given
index
Method GetCoefficient(int, int) (p. 1135) Gets the Coefficient property at given
LoadCombination index and BaseCase index
Method GetLoadCombinationName(int) (p. 1135)Gets the LoadCombination Name property at given
index
Method GetLoadCombinationType(int) (p. 1136)Gets the Load Combination Type property at given
index
Method Import(string) (p. 1136) Import Load Combination Definition data from
Comma Separated Value (CSV) files
Method SetBaseCaseAnalysis(int, Sets the BaseCase Analysis property to given index.
Analysis) (p. 1136)
Method SetBaseCaseFrequency(int, Sets the Frequency property to the Base Case at
double) (p. 1137) given index
Method SetBaseCaseName(int, string) (p. 1137) Sets the BaseCase Name property at given index
Method SetBaseCasePhaseAngle(int, Sets the Phase Angle property to the Base Case at
double) (p. 1137) given index
Method SetBaseCaseTime(int, double) (p. 1138) Sets the Time property to the Base Case at given
index
Method SetCoefficient(int, int, double) (p. 1138) Sets the Coefficient property at given
LoadCombination index and BaseCase index
Method SetLoadCombinationName(int, Sets the LoadCombination Name property at given
string) (p. 1139) index
Method SetLoadCombinationType(int, Sets the Load Combination Type property at given
LoadCombinationType) (p. 1139) index

BaseCaseCount
Gets the number of bases cases

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1131
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int BaseCaseCount { get; }

LoadCombinationCount
Gets the number of load combinations

Declaration Syntax
public int LoadCombinationCount { get; }

AddBaseCase(string, Analysis, double)


Add a BaseCase to the SolutionCombinationDefinition

Declaration Syntax
public void AddBaseCase(string name, Analysis analysis, double time)

Parameters
name(string)

Name of the BaseCase

analysis(Analysis)

Analysis object to use as BaseCase

time(double)

Time of Analysis to use as BaseCase (Defaults to EndTime)

AddLoadCombination(string, int)
Add a LoadCombination to the SolutionCombination Definition

Declaration Syntax
public void AddLoadCombination(string name, int type)

Parameters
name(string)

Name of the Load Combination

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1132 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

type(int)

Type of the Load Combination (0 for Linear, 1 for SRSS)

DeleteBaseCase(int)
Delete a BaseCase from the SolutionCombinationDefinition

Declaration Syntax
public void DeleteBaseCase(int index)

Parameters
index(int)

Index to delete Base Case at

DeleteLoadCombination(int)
Delete a LoadCombination from the SolutionCombination Definition

Declaration Syntax
public void DeleteLoadCombination(int index)

Parameters
index(int)

Index of the LoadCombination to delete

Export(string)
Export Load Combination Definition data to Comma Separated Value (CSV) files

Declaration Syntax
public void Export(string filepath)

Parameters
filepath(string)

Complete filepath to exported CSV file

GetBaseCaseAnalysis(int)
Gets the BaseCase Analysis property at given index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1133
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Analysis GetBaseCaseAnalysis(int index)

Parameters
index(int)

Index to get Base Case Analysis at

GetBaseCaseFrequency(int)
Gets the Frequency property from the Base Case at given index

Declaration Syntax
public double GetBaseCaseFrequency(int index)

Parameters
index(int)

Index to get Base Case Frequency at

GetBaseCaseName(int)
Gets the BaseCase Name property at given index

Declaration Syntax
public string GetBaseCaseName(int index)

Parameters
index(int)

Index to get Base Case Name at

GetBaseCasePhaseAngle(int)
Gets the Phase Angle property from the Base Case at given index

Declaration Syntax
public double GetBaseCasePhaseAngle(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1134 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

Parameters
index(int)

Index to get Base Case Phase Angle at

GetBaseCaseTime(int)
Gets the Time property from the Base Case at given index

Declaration Syntax
public double GetBaseCaseTime(int index)

Parameters
index(int)

Index to get Base Case Time at

GetCoefficient(int, int)
Gets the Coefficient property at given LoadCombination index and BaseCase index

Declaration Syntax
public double GetCoefficient(int LCindex, int BCindex)

Parameters
LCindex(int)

LoadCombination index (row)

BCindex(int)

BaseCase index (column)

GetLoadCombinationName(int)
Gets the LoadCombination Name property at given index

Declaration Syntax
public string GetLoadCombinationName(int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1135
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

Index to get LoadCombination Name at

GetLoadCombinationType(int)
Gets the Load Combination Type property at given index

Declaration Syntax
public LoadCombinationType GetLoadCombinationType(int index)

Parameters
index(int)

Index to get Load Combination Type at

Import(string)
Import Load Combination Definition data from Comma Separated Value (CSV) files

Declaration Syntax
public void Import(string filepath)

Parameters
filepath(string)

Complete filepath to CSV file to import from

SetBaseCaseAnalysis(int, Analysis)
Sets the BaseCase Analysis property to given index.

Declaration Syntax
public void SetBaseCaseAnalysis(int index, Analysis analysis)

Parameters
index(int)

Index to set Base Case Analysis at

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1136 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionCombinationDefinition

analysis(Analysis)

Analysis object to set as Base Case Analysis

SetBaseCaseFrequency(int, double)
Sets the Frequency property to the Base Case at given index

Declaration Syntax
public void SetBaseCaseFrequency(int index, double value)

Parameters
index(int)

Index to set Base Case frequency at

value(double)

Value of frequency to set

SetBaseCaseName(int, string)
Sets the BaseCase Name property at given index

Declaration Syntax
public void SetBaseCaseName(int index, string name)

Parameters
index(int)

Index to set Base Case Name at

name(string)

Base Case Name string

SetBaseCasePhaseAngle(int, double)
Sets the Phase Angle property to the Base Case at given index

Declaration Syntax
public void SetBaseCasePhaseAngle(int index, double value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1137
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

Index to set Base Case Phase Angle at

value(double)

Value of Phase Angle to set

SetBaseCaseTime(int, double)
Sets the Time property to the Base Case at given index

Declaration Syntax
public void SetBaseCaseTime(int index, double value)

Parameters
index(int)

Index to set Base Case time at

value(double)

Value of time to set

SetCoefficient(int, int, double)


Sets the Coefficient property at given LoadCombination index and BaseCase index

Declaration Syntax
public void SetCoefficient(int LCindex, int BCindex, double value)

Parameters
LCindex(int)

LoadCombination index (row)

BCindex(int)

BaseCase index (column)

value(double)

Coefficient value

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1138 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

SetLoadCombinationName(int, string)
Sets the LoadCombination Name property at given index

Declaration Syntax
public void SetLoadCombinationName(int index, string name)

Parameters
index(int)

Index to set LoadCombination Name at

name(string)

Base Case Name string

SetLoadCombinationType(int, LoadCombinationType)
Sets the Load Combination Type property at given index

Declaration Syntax
public void SetLoadCombinationType(int index, LoadCombinationType value)

Parameters
index(int)

Index to set Load Combination Type at

value(LoadCombinationType)

0 = Linear evaluation, 1 = SRSS evaluation

SolutionInformation
Defines a SolutionInformation.

Declaration Syntax
public class SolutionInformation : DataModelObject, ISupportChartOptions, IFolderDataModelObject

Table 336: Members

Property ActivateVisibility (p. 1143) Gets or sets the ActivateVisibility.


Property Children (p. 1143) Gets the list of children.
Property Comments (p. 1144) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1139
Ansys.ACT.Automation.Mechanical Namespace

Property Component (p. 1144) Gets or sets the Component.


Property DataModelObjectCategory (p. 1144) Gets the current DataModelObject's category.
Property Display (p. 1144) Gets or sets the Display.
Property DisplayFilterDuringSolve (p. 1144) Gets or sets the DisplayFilterDuringSolve.
Property DisplayPoints (p. 1144) Gets or sets the DisplayPoints.
Property DisplayType (p. 1145) Gets or sets the DisplayType.
Property DrawConnectionsAttachedTo (p. 1145) Gets or sets the
DrawConnectionsAttachedTo.
Property EnvironmentSelection (p. 1145) Gets or Sets the EnvironmentSelection to an
Analysis object.
Property Figures (p. 1145) Gets the list of associated figures.
Property IdentifyElementViolations (p. 1145) Gets or sets the IdentifyElementViolations.
Property Images (p. 1145) Gets the list of associated images.
Property InternalObject (p. 1146) Gets the internal object. For advanced usage
only.
Property LineColor (p. 1146) Gets or sets the LineColor.
Property LineThickness (p. 1146) Gets or sets the LineThickness.
Property ModeNumber (p. 1146) Gets or sets the ModeNumber.
Property NewtonRaphsonResiduals (p. 1146) Gets or sets the NewtonRaphsonResiduals.
Property ResponseConstraint (p. 1146) Gets or sets the ResponseConstraint.
Property ShowChargeResiduals (p. 1147) Gets or sets the ShowChargeResiduals.
Property ShowHeatResiduals (p. 1147) Gets or sets the ShowHeatResiduals.
Property ShowMomentResiduals (p. 1147) Gets or sets the ShowMomentResiduals.
Property SolutionOutput (p. 1147) Gets or sets the SolutionOutput.
Property StepNumber (p. 1147) Gets or sets the StepNumber.
Property StepSelectionMode (p. 1147) Gets or sets the StepSelectionMode.
Property SummaryType (p. 1148) Gets or sets the SummaryType.
Property UpdateInterval (p. 1148) Gets or sets the UpdateInterval.
Property VisibleOnResults (p. 1148) Gets or sets the VisibleOnResults.
Method AddAddedMass() (p. 1148) Creates a new AddedMassTracker
Method AddArtificialEnergy() (p. 1148) Creates a new ArtificialEnergyTracker
Method AddChattering() (p. 1148) Creates a new ContactChatteringTracker
Method AddClosedPenetration() (p. 1149) Creates a new
ContactClosedPenetrationTracker
Method AddComment() (p. 1149) Creates a new child Comment.
Method AddContactDepth() (p. 1149) Creates a new ContactDepthTracker
Method AddContactEnergy() (p. 1149) Creates a new ContactEnergyTracker
Method AddContactForce() (p. 1149) Creates a new ContactForceTracker
Method AddContactHeatFlux() (p. 1149) Creates a new ContactHeatFluxTracker
Method AddContactingArea() (p. 1150) Creates a new ContactingAreaTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1140 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Method AddContactMaximumNormalStiffness() (p. 1150) Creates a new


ContactMaximumNormalStiffnessTracker
Method AddContactMaxTangentialFluidPressure() (p. 1150)Creates a new
ContactMaxTangentialFluidPressureTracker
Method AddContactMinimumNormalStiffness() (p. 1150) Creates a new
ContactMinimumNormalStiffnessTracker
Method AddContactPairForceConvergenceNorm() (p. 1150)Creates a new
ContactPairForceConvergenceNormTracker
Method AddContactPressure() (p. 1150) Creates a new ContactPressureTracker
Method AddDampingEnergy() (p. 1151) Creates a new DampingEnergyTracker
Method AddDeformationPlotTracker() (p. 1151) Creates a new TotalDeformation Plot Tracker.
Method AddDensity() (p. 1151) Creates a new DensityTracker
Method AddDirectionalAcceleration() (p. 1151) Creates a new DirectionalAccelerationTracker
Method AddDirectionalDeformation() (p. 1151) Creates a new DirectionalDeformationTracker
Method AddDirectionalVelocity() (p. 1151) Creates a new DirectionalVelocityTracker
Method AddEffectiveStrain() (p. 1152) Creates a new EffectiveStrainTracker
Method AddEffectiveStress() (p. 1152) Creates a new EffectiveStressTracker
Method AddElasticSlip() (p. 1152) Creates a new ContactElasticSlipTracker
Method AddErodedInternalEnergy() (p. 1152) Creates a new ErodedInternalEnergyTracker
Method AddErodedKineticEnergy() (p. 1152) Creates a new ErodedKineticEnergyTracker
Method AddExternalForce() (p. 1152) Creates a new ExternalForceTracker
Method AddFigure() (p. 1153) Creates a new child Figure.
Method AddFluidPressure() (p. 1153) Creates a new ContactFluidPressureTracker
Method AddForceReaction() (p. 1153) Creates a new ForceReactionTracker
Method AddFrictionalDissipationEnergy() (p. 1153) Creates a new
ContactFrictionalDissipationEnergyTracker
Method AddFrictionalStress() (p. 1153) Creates a new ContactFrictionalStressTracker
Method AddGap() (p. 1153) Creates a new ContactGapTracker
Method AddHourglassEnergy() (p. 1154) Creates a new HourglassEnergyTracker
Method AddImage(string) (p. 1154) Creates a new child Image. If a filePath is
provided, the image will be loaded from that
file, if not, the image will be a screen capture
of the Geometry window.
Method AddInternalEnergy() (p. 1154) Creates a new InternalEnergyTracker
Method AddKineticEnergy() (p. 1154) Creates a new KineticEnergyTracker
Method AddLatticeDensity() (p. 1154) Creates a new LatticeDensity
Method AddLatticeElementalDensity() (p. 1155) Creates a new LatticeElementalDensity
Method AddLSDYNAGeneralTracker() (p. 1155) Creates a new LSDYNAGeneralTracker
Method AddMaximumDampingPressure() (p. 1155) Creates a new
ContactMaximumDampingPressureTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1141
Ansys.ACT.Automation.Mechanical Namespace

Method AddMaximumGeometricSlidingDistance() (p. 1155)Creates a new


ContactMaximumGeometricSlidingDistanceTracker
Method AddMaximumTangentialStiffness() (p. 1155) Creates a new
ContactMaximumTangentialStiffnessTracker
Method AddMinimumGeometricSlidingDistance() (p. 1155)Creates a new
ContactMinimumGeometricSlidingDistanceTracker
Method AddMinimumTangentialStiffness() (p. 1156) Creates a new
ContactMinimumTangentialStiffnessTracker
Method AddMomentReaction() (p. 1156) Creates a new MomentReactionTracker
Method AddMomentum() (p. 1156) Creates a new MomentumTracker
Method AddNonLinearStabilizationEnergy() (p. 1156) Creates a new
NonLinearStabilizationEnergyTracker
Method AddNumberContacting() (p. 1156) Creates a new NumberContactingTracker
Method AddNumberSticking() (p. 1156) Creates a new
ContactNumberStickingTracker
Method AddNumberWithLargePenetration() (p. 1157) Creates a new
ContactNumberWithLargePenetrationTracker
Method AddNumberWithTooMuchSliding() (p. 1157) Creates a new
ContactNumberWithTooMuchSlidingTracker
Method AddPenetration() (p. 1157) Creates a new ContactPenetrationTracker
Method AddPlasticWork() (p. 1157) Creates a new PlasticWorkTracker
Method AddPosition() (p. 1157) Creates a new PositionTracker
Method AddPossibleOverconstraint() (p. 1157) Creates a new
ContactPossibleOverconstraintTracker
Method AddPressure() (p. 1158) Creates a new PressureTracker
Method AddResultingPinball() (p. 1158) Creates a new
ContactResultingPinballTracker
Method AddRigidBodyVelocity() (p. 1158) Creates a new RigidBodyVelocityTracker
Method AddSlidingDistance() (p. 1158) Creates a new ContactSlidingDistanceTracker
Method AddSlidingIndication() (p. 1158) Creates a new
ContactSlidingIndicationTracker
Method AddSpringTrackerDampingForce() (p. 1158) Creates a new SpringDampingForceTracker
Method AddSpringTrackerElasticForce() (p. 1159) Creates a new SpringElasticForceTracker
Method AddSpringTrackerElongation() (p. 1159) Creates a new SpringElongationTracker
Method AddSpringTrackerVelocity() (p. 1159) Creates a new SpringVelocityTracker
Method AddStabilizationEnergy() (p. 1159) Creates a new
ContactStabilizationEnergyTracker
Method AddStiffnessEnergy() (p. 1159) Creates a new StiffnessEnergyTracker
Method AddStrainEnergy() (p. 1159) Creates a new ContactStrainEnergyTracker
Method AddStrainPlotTracker() (p. 1160) Creates a new EquivalentElasticStrainRST Plot
Tracker.
Method AddStressPlotTracker() (p. 1160) Creates a new EquivalentStress Plot Tracker.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1142 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Method AddTangentialDampingStress() (p. 1160) Creates a new


ContactTangentialDampingStressTracker
Method AddTemperature() (p. 1160) Creates a new TemperatureTracker
Method AddTemperaturePlotTracker() (p. 1160) Creates a new TemperatureResult Plot
Tracker.
Method AddTopologyDensity() (p. 1160) Creates a new TopologyDensity
Method AddTopologyElementalDensity() (p. 1161) Creates a new TopologyElementalDensity
Method AddTotalEnergy() (p. 1161) Creates a new TotalEnergyTracker
Method AddTotalForceFromContactPressureX() (p. 1161) Creates a new
ContactTotalForceFromContactPressureXTracker
Method AddTotalForceFromContactPressureY() (p. 1161) Creates a new
ContactTotalForceFromContactPressureYTracker
Method AddTotalForceFromContactPressureZ() (p. 1161) Creates a new
ContactTotalForceFromContactPressureZTracker
Method AddTotalForceFromTangentialStressX() (p. 1161) Creates a new
ContactTotalForceFromTangentialStressXTracker
Method AddTotalForceFromTangentialStressY() (p. 1162) Creates a new
ContactTotalForceFromTangentialStressYTracker
Method AddTotalForceFromTangentialStressZ() (p. 1162) Creates a new
ContactTotalForceFromTangentialStressZTracker
Method AddTotalMassAverageVelocity() (p. 1162) Creates a new
TotalMassAverageVelocityTracker
Method AddVolumeLossDueToWear() (p. 1162) Creates a new
ContactVolumeLossDueToWearTracker
Method EvaluateAllContactTrackers() (p. 1162) Run the EvaluateAllContactTrackers action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1162)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1163)
Method ImportResultTrackersFromFile(string) (p. 1163) Import Result Trackers from File.
Method RenameBasedOnDefinition() (p. 1164) Run the RenameBasedOnDefinition action.

ActivateVisibility
Gets or sets the ActivateVisibility.

Declaration Syntax
public bool ActivateVisibility { set;get; }

Children
Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1143
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Component
Gets or sets the Component.

Declaration Syntax
public OptimizationResponseConstraintComponentType Component { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Display
Gets or sets the Display.

Declaration Syntax
public FEConnectionDisplay Display { set;get; }

DisplayFilterDuringSolve
Gets or sets the DisplayFilterDuringSolve.

Declaration Syntax
public bool DisplayFilterDuringSolve { set;get; }

DisplayPoints
Gets or sets the DisplayPoints.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1144 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public double DisplayPoints { set;get; }

DisplayType
Gets or sets the DisplayType.

Declaration Syntax
public FEConnectionDisplayType DisplayType { set;get; }

DrawConnectionsAttachedTo
Gets or sets the DrawConnectionsAttachedTo.

Declaration Syntax
public NodeSelection DrawConnectionsAttachedTo { set;get; }

EnvironmentSelection
Gets or Sets the EnvironmentSelection to an Analysis object.

Declaration Syntax
public object EnvironmentSelection { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

IdentifyElementViolations
Gets or sets the IdentifyElementViolations.

Declaration Syntax
public int IdentifyElementViolations { set;get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1145
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSolutionInfoToolAuto InternalObject { get; }

LineColor
Gets or sets the LineColor.

Declaration Syntax
public FEConnectionLineColor LineColor { set;get; }

LineThickness
Gets or sets the LineThickness.

Declaration Syntax
public FEConnectionLineThicknessType LineThickness { set;get; }

ModeNumber
Gets or sets the ModeNumber.

Declaration Syntax
public int ModeNumber { set;get; }

NewtonRaphsonResiduals
Gets or sets the NewtonRaphsonResiduals.

Declaration Syntax
public int NewtonRaphsonResiduals { set;get; }

ResponseConstraint
Gets or sets the ResponseConstraint.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1146 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public ResponseConstraint ResponseConstraint { set;get; }

ShowChargeResiduals
Gets or sets the ShowChargeResiduals.

Declaration Syntax
public bool ShowChargeResiduals { set;get; }

ShowHeatResiduals
Gets or sets the ShowHeatResiduals.

Declaration Syntax
public bool ShowHeatResiduals { set;get; }

ShowMomentResiduals
Gets or sets the ShowMomentResiduals.

Declaration Syntax
public bool ShowMomentResiduals { set;get; }

SolutionOutput
Gets or sets the SolutionOutput.

Declaration Syntax
public SolutionOutputType SolutionOutput { set;get; }

StepNumber
Gets or sets the StepNumber.

Declaration Syntax
public int StepNumber { set;get; }

StepSelectionMode
Gets or sets the StepSelectionMode.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1147
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public SeqSelectionMode StepSelectionMode { set;get; }

SummaryType
Gets or sets the SummaryType.

Declaration Syntax
public PFactorResultType SummaryType { set;get; }

UpdateInterval
Gets or sets the UpdateInterval.

Declaration Syntax
public double UpdateInterval { set;get; }

VisibleOnResults
Gets or sets the VisibleOnResults.

Declaration Syntax
public bool VisibleOnResults { set;get; }

AddAddedMass()
Creates a new AddedMassTracker

Declaration Syntax
public virtual AddedMassTracker AddAddedMass()

AddArtificialEnergy()
Creates a new ArtificialEnergyTracker

Declaration Syntax
public virtual ArtificialEnergyTracker AddArtificialEnergy()

AddChattering()
Creates a new ContactChatteringTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1148 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual ContactChatteringTracker AddChattering()

AddClosedPenetration()
Creates a new ContactClosedPenetrationTracker

Declaration Syntax
public virtual ContactClosedPenetrationTracker AddClosedPenetration()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddContactDepth()
Creates a new ContactDepthTracker

Declaration Syntax
public virtual ContactDepthTracker AddContactDepth()

AddContactEnergy()
Creates a new ContactEnergyTracker

Declaration Syntax
public virtual ContactEnergyTracker AddContactEnergy()

AddContactForce()
Creates a new ContactForceTracker

Declaration Syntax
public virtual ContactForceTracker AddContactForce()

AddContactHeatFlux()
Creates a new ContactHeatFluxTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1149
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactHeatFluxTracker AddContactHeatFlux()

AddContactingArea()
Creates a new ContactingAreaTracker

Declaration Syntax
public virtual ContactingAreaTracker AddContactingArea()

AddContactMaximumNormalStiffness()
Creates a new ContactMaximumNormalStiffnessTracker

Declaration Syntax
public virtual ContactMaximumNormalStiffnessTracker AddContactMaximumNormalStiffness()

AddContactMaxTangentialFluidPressure()
Creates a new ContactMaxTangentialFluidPressureTracker

Declaration Syntax
public virtual ContactMaxTangentialFluidPressureTracker AddContactMaxTangentialFluidPressure()

AddContactMinimumNormalStiffness()
Creates a new ContactMinimumNormalStiffnessTracker

Declaration Syntax
public virtual ContactMinimumNormalStiffnessTracker AddContactMinimumNormalStiffness()

AddContactPairForceConvergenceNorm()
Creates a new ContactPairForceConvergenceNormTracker

Declaration Syntax
public virtual ContactPairForceConvergenceNormTracker AddContactPairForceConvergenceNorm()

AddContactPressure()
Creates a new ContactPressureTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1150 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual ContactPressureTracker AddContactPressure()

AddDampingEnergy()
Creates a new DampingEnergyTracker

Declaration Syntax
public virtual DampingEnergyTracker AddDampingEnergy()

AddDeformationPlotTracker()
Creates a new TotalDeformation Plot Tracker.

Declaration Syntax
public virtual TotalDeformation AddDeformationPlotTracker()

AddDensity()
Creates a new DensityTracker

Declaration Syntax
public virtual DensityTracker AddDensity()

AddDirectionalAcceleration()
Creates a new DirectionalAccelerationTracker

Declaration Syntax
public virtual DirectionalAccelerationTracker AddDirectionalAcceleration()

AddDirectionalDeformation()
Creates a new DirectionalDeformationTracker

Declaration Syntax
public virtual DirectionalDeformationTracker AddDirectionalDeformation()

AddDirectionalVelocity()
Creates a new DirectionalVelocityTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1151
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual DirectionalVelocityTracker AddDirectionalVelocity()

AddEffectiveStrain()
Creates a new EffectiveStrainTracker

Declaration Syntax
public virtual EffectiveStrainTracker AddEffectiveStrain()

AddEffectiveStress()
Creates a new EffectiveStressTracker

Declaration Syntax
public virtual EffectiveStressTracker AddEffectiveStress()

AddElasticSlip()
Creates a new ContactElasticSlipTracker

Declaration Syntax
public virtual ContactElasticSlipTracker AddElasticSlip()

AddErodedInternalEnergy()
Creates a new ErodedInternalEnergyTracker

Declaration Syntax
public virtual ErodedInternalEnergyTracker AddErodedInternalEnergy()

AddErodedKineticEnergy()
Creates a new ErodedKineticEnergyTracker

Declaration Syntax
public virtual ErodedKineticEnergyTracker AddErodedKineticEnergy()

AddExternalForce()
Creates a new ExternalForceTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1152 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual ExternalForceTracker AddExternalForce()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddFluidPressure()
Creates a new ContactFluidPressureTracker

Declaration Syntax
public virtual ContactFluidPressureTracker AddFluidPressure()

AddForceReaction()
Creates a new ForceReactionTracker

Declaration Syntax
public virtual ForceReactionTracker AddForceReaction()

AddFrictionalDissipationEnergy()
Creates a new ContactFrictionalDissipationEnergyTracker

Declaration Syntax
public virtual ContactFrictionalDissipationEnergyTracker AddFrictionalDissipationEnergy()

AddFrictionalStress()
Creates a new ContactFrictionalStressTracker

Declaration Syntax
public virtual ContactFrictionalStressTracker AddFrictionalStress()

AddGap()
Creates a new ContactGapTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1153
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactGapTracker AddGap()

AddHourglassEnergy()
Creates a new HourglassEnergyTracker

Declaration Syntax
public virtual HourglassEnergyTracker AddHourglassEnergy()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddInternalEnergy()
Creates a new InternalEnergyTracker

Declaration Syntax
public virtual InternalEnergyTracker AddInternalEnergy()

AddKineticEnergy()
Creates a new KineticEnergyTracker

Declaration Syntax
public virtual KineticEnergyTracker AddKineticEnergy()

AddLatticeDensity()
Creates a new LatticeDensity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1154 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual LatticeDensity AddLatticeDensity()

AddLatticeElementalDensity()
Creates a new LatticeElementalDensity

Declaration Syntax
public virtual LatticeElementalDensity AddLatticeElementalDensity()

AddLSDYNAGeneralTracker()
Creates a new LSDYNAGeneralTracker

Declaration Syntax
public virtual LSDYNAGeneralTracker AddLSDYNAGeneralTracker()

AddMaximumDampingPressure()
Creates a new ContactMaximumDampingPressureTracker

Declaration Syntax
public virtual ContactMaximumDampingPressureTracker AddMaximumDampingPressure()

AddMaximumGeometricSlidingDistance()
Creates a new ContactMaximumGeometricSlidingDistanceTracker

Declaration Syntax
public virtual ContactMaximumGeometricSlidingDistanceTracker AddMaximumGeometricSlidingDis-
tance()

AddMaximumTangentialStiffness()
Creates a new ContactMaximumTangentialStiffnessTracker

Declaration Syntax
public virtual ContactMaximumTangentialStiffnessTracker AddMaximumTangentialStiffness()

AddMinimumGeometricSlidingDistance()
Creates a new ContactMinimumGeometricSlidingDistanceTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1155
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactMinimumGeometricSlidingDistanceTracker AddMinimumGeometricSlidingDis-
tance()

AddMinimumTangentialStiffness()
Creates a new ContactMinimumTangentialStiffnessTracker

Declaration Syntax
public virtual ContactMinimumTangentialStiffnessTracker AddMinimumTangentialStiffness()

AddMomentReaction()
Creates a new MomentReactionTracker

Declaration Syntax
public virtual MomentReactionTracker AddMomentReaction()

AddMomentum()
Creates a new MomentumTracker

Declaration Syntax
public virtual MomentumTracker AddMomentum()

AddNonLinearStabilizationEnergy()
Creates a new NonLinearStabilizationEnergyTracker

Declaration Syntax
public virtual NonLinearStabilizationEnergyTracker AddNonLinearStabilizationEnergy()

AddNumberContacting()
Creates a new NumberContactingTracker

Declaration Syntax
public virtual NumberContactingTracker AddNumberContacting()

AddNumberSticking()
Creates a new ContactNumberStickingTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1156 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual ContactNumberStickingTracker AddNumberSticking()

AddNumberWithLargePenetration()
Creates a new ContactNumberWithLargePenetrationTracker

Declaration Syntax
public virtual ContactNumberWithLargePenetrationTracker AddNumberWithLargePenetration()

AddNumberWithTooMuchSliding()
Creates a new ContactNumberWithTooMuchSlidingTracker

Declaration Syntax
public virtual ContactNumberWithTooMuchSlidingTracker AddNumberWithTooMuchSliding()

AddPenetration()
Creates a new ContactPenetrationTracker

Declaration Syntax
public virtual ContactPenetrationTracker AddPenetration()

AddPlasticWork()
Creates a new PlasticWorkTracker

Declaration Syntax
public virtual PlasticWorkTracker AddPlasticWork()

AddPosition()
Creates a new PositionTracker

Declaration Syntax
public virtual PositionTracker AddPosition()

AddPossibleOverconstraint()
Creates a new ContactPossibleOverconstraintTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1157
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactPossibleOverconstraintTracker AddPossibleOverconstraint()

AddPressure()
Creates a new PressureTracker

Declaration Syntax
public virtual PressureTracker AddPressure()

AddResultingPinball()
Creates a new ContactResultingPinballTracker

Declaration Syntax
public virtual ContactResultingPinballTracker AddResultingPinball()

AddRigidBodyVelocity()
Creates a new RigidBodyVelocityTracker

Declaration Syntax
public virtual RigidBodyVelocityTracker AddRigidBodyVelocity()

AddSlidingDistance()
Creates a new ContactSlidingDistanceTracker

Declaration Syntax
public virtual ContactSlidingDistanceTracker AddSlidingDistance()

AddSlidingIndication()
Creates a new ContactSlidingIndicationTracker

Declaration Syntax
public virtual ContactSlidingIndicationTracker AddSlidingIndication()

AddSpringTrackerDampingForce()
Creates a new SpringDampingForceTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1158 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual SpringDampingForceTracker AddSpringTrackerDampingForce()

AddSpringTrackerElasticForce()
Creates a new SpringElasticForceTracker

Declaration Syntax
public virtual SpringElasticForceTracker AddSpringTrackerElasticForce()

AddSpringTrackerElongation()
Creates a new SpringElongationTracker

Declaration Syntax
public virtual SpringElongationTracker AddSpringTrackerElongation()

AddSpringTrackerVelocity()
Creates a new SpringVelocityTracker

Declaration Syntax
public virtual SpringVelocityTracker AddSpringTrackerVelocity()

AddStabilizationEnergy()
Creates a new ContactStabilizationEnergyTracker

Declaration Syntax
public virtual ContactStabilizationEnergyTracker AddStabilizationEnergy()

AddStiffnessEnergy()
Creates a new StiffnessEnergyTracker

Declaration Syntax
public virtual StiffnessEnergyTracker AddStiffnessEnergy()

AddStrainEnergy()
Creates a new ContactStrainEnergyTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1159
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactStrainEnergyTracker AddStrainEnergy()

AddStrainPlotTracker()
Creates a new EquivalentElasticStrainRST Plot Tracker.

Declaration Syntax
public virtual EquivalentElasticStrainRST AddStrainPlotTracker()

AddStressPlotTracker()
Creates a new EquivalentStress Plot Tracker.

Declaration Syntax
public virtual EquivalentStress AddStressPlotTracker()

AddTangentialDampingStress()
Creates a new ContactTangentialDampingStressTracker

Declaration Syntax
public virtual ContactTangentialDampingStressTracker AddTangentialDampingStress()

AddTemperature()
Creates a new TemperatureTracker

Declaration Syntax
public virtual TemperatureTracker AddTemperature()

AddTemperaturePlotTracker()
Creates a new TemperatureResult Plot Tracker.

Declaration Syntax
public virtual TemperatureResult AddTemperaturePlotTracker()

AddTopologyDensity()
Creates a new TopologyDensity

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1160 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual TopologyDensity AddTopologyDensity()

AddTopologyElementalDensity()
Creates a new TopologyElementalDensity

Declaration Syntax
public virtual TopologyElementalDensity AddTopologyElementalDensity()

AddTotalEnergy()
Creates a new TotalEnergyTracker

Declaration Syntax
public virtual TotalEnergyTracker AddTotalEnergy()

AddTotalForceFromContactPressureX()
Creates a new ContactTotalForceFromContactPressureXTracker

Declaration Syntax
public virtual ContactTotalForceFromContactPressureXTracker AddTotalForceFromContactPressureX()

AddTotalForceFromContactPressureY()
Creates a new ContactTotalForceFromContactPressureYTracker

Declaration Syntax
public virtual ContactTotalForceFromContactPressureYTracker AddTotalForceFromContactPressureY()

AddTotalForceFromContactPressureZ()
Creates a new ContactTotalForceFromContactPressureZTracker

Declaration Syntax
public virtual ContactTotalForceFromContactPressureZTracker AddTotalForceFromContactPressureZ()

AddTotalForceFromTangentialStressX()
Creates a new ContactTotalForceFromTangentialStressXTracker

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1161
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ContactTotalForceFromTangentialStressXTracker AddTotalForceFromTangentialStressX()

AddTotalForceFromTangentialStressY()
Creates a new ContactTotalForceFromTangentialStressYTracker

Declaration Syntax
public virtual ContactTotalForceFromTangentialStressYTracker AddTotalForceFromTangentialStressY()

AddTotalForceFromTangentialStressZ()
Creates a new ContactTotalForceFromTangentialStressZTracker

Declaration Syntax
public virtual ContactTotalForceFromTangentialStressZTracker AddTotalForceFromTangentialStressZ()

AddTotalMassAverageVelocity()
Creates a new TotalMassAverageVelocityTracker

Declaration Syntax
public virtual TotalMassAverageVelocityTracker AddTotalMassAverageVelocity()

AddVolumeLossDueToWear()
Creates a new ContactVolumeLossDueToWearTracker

Declaration Syntax
public virtual ContactVolumeLossDueToWearTracker AddVolumeLossDueToWear()

EvaluateAllContactTrackers()
Run the EvaluateAllContactTrackers action.

Declaration Syntax
public virtual void EvaluateAllContactTrackers()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1162 of ANSYS, Inc. and its subsidiaries and affiliates.
SolutionInformation

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ImportResultTrackersFromFile(string)
Import Result Trackers from File.

Declaration Syntax
public virtual void ImportResultTrackersFromFile(string fileName)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1163
Ansys.ACT.Automation.Mechanical Namespace

Parameters
fileName(string)

No details are provided for this entry.

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Stage
Defines a Stage.

Declaration Syntax
public class Stage : ImportedDataModelObject, IFolderDataModelObject

Table 337: Members

Property Behavior (p. 1165) Gets the Behavior.


Property Children (p. 1165) Gets the list of children.
Property Comments (p. 1165) Gets the list of associated
comments.
Property CyclicRegion (p. 1165) Gets or sets the CyclicRegion.
Property DataModelObjectCategory (p. 1166) Gets the current
DataModelObject's category.
Property Figures (p. 1166) Gets the list of associated figures.
Property Images (p. 1166) Gets the list of associated images.
Property InternalObject (p. 1166) Gets the internal object. For
advanced usage only.
Property Location (p. 1166) Gets or sets the Location.
Property StageName (p. 1166) Gets the StageName.
Property Suppressed (p. 1167) Gets or sets the Suppressed.
Method AddComment() (p. 1167) Creates a new child Comment.
Method AddFigure() (p. 1167) Creates a new child Figure.
Method AddImage(string) (p. 1167) Creates a new child Image. If a
filePath is provided, the image will
be loaded from that file, if not, the
image will be a screen capture of
the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1164 of ANSYS, Inc. and its subsidiaries and affiliates.
Stage

Method Delete() (p. 1167) Run the Delete action.


Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 1168) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 1168) type.
Method GetHarmonicIndexForEnvironmentByIndex(uint, Gets the worksheet harmonic index
int) (p. 1168) for a given environment at index.
Method GetHarmonicIndexNumberForEnvironment(uint) (p. 1169)Gets the worksheet number of
harmonic indexes for a given
environment.
Method SetHarmonicIndexForEnvironmentByIndex(uint, int, Sets the worksheet harmonic index
uint) (p. 1169) for a given environment at index.
Method SetHarmonicIndexNumberForEnvironment(uint, Sets the worksheet number of
uint) (p. 1169) harmonic indexes for a given
environment.

Behavior
Gets the Behavior.

Declaration Syntax
public StageBehavior Behavior { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CyclicRegion
Gets or sets the CyclicRegion.

Declaration Syntax
public SymmetryGeneral CyclicRegion { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1165
Ansys.ACT.Automation.Mechanical Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSStageAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

StageName
Gets the StageName.

Declaration Syntax
public string StageName { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1166 of ANSYS, Inc. and its subsidiaries and affiliates.
Stage

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1167
Ansys.ACT.Automation.Mechanical Namespace

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetHarmonicIndexForEnvironmentByIndex(uint, int)
Gets the worksheet harmonic index for a given environment at index.

Declaration Syntax
public virtual uint GetHarmonicIndexForEnvironmentByIndex(uint envId, int index)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1168 of ANSYS, Inc. and its subsidiaries and affiliates.
Stage

Parameters
envId(uint)

No details are provided for this entry.

index(int)

No details are provided for this entry.

GetHarmonicIndexNumberForEnvironment(uint)
Gets the worksheet number of harmonic indexes for a given environment.

Declaration Syntax
public virtual uint GetHarmonicIndexNumberForEnvironment(uint envId)

Parameters
envId(uint)

No details are provided for this entry.

SetHarmonicIndexForEnvironmentByIndex(uint, int, uint)


Sets the worksheet harmonic index for a given environment at index.

Declaration Syntax
public virtual void SetHarmonicIndexForEnvironmentByIndex(uint envId, int index, uint newVal)

Parameters
envId(uint)

No details are provided for this entry.

index(int)

No details are provided for this entry.

newVal(uint)

No details are provided for this entry.

SetHarmonicIndexNumberForEnvironment(uint, uint)
Sets the worksheet number of harmonic indexes for a given environment.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1169
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void SetHarmonicIndexNumberForEnvironment(uint envId, uint newVal)

Parameters
envId(uint)

No details are provided for this entry.

newVal(uint)

No details are provided for this entry.

STL
Defines a STL.

Declaration Syntax
public class STL : GeometryFileContainer

Table 338: Members

Property Children (p. 592) Gets the list of children.

(Inherited from
GeometryFileContainer (p. 591).)
Property Color (p. 1171) Gets or sets the Color.
Property Comments (p. 592) Gets the list of associated comments.

(Inherited from
GeometryFileContainer (p. 591).)
Property DataModelObjectCategory (p. 1171)Gets the current DataModelObject's
category.
Property Figures (p. 592) Gets the list of associated figures.

(Inherited from
GeometryFileContainer (p. 591).)
Property FileName (p. 1171) Gets or sets the FileName.
Property Images (p. 592) Gets the list of associated images.

(Inherited from
GeometryFileContainer (p. 591).)
Property InternalObject (p. 1171) Gets the internal object. For advanced usage
only.
Property LengthUnits (p. 593) Gets or sets the LengthUnits.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1170 of ANSYS, Inc. and its subsidiaries and affiliates.
STL

(Inherited from
GeometryFileContainer (p. 591).)
Property ShowAlways (p. 593) Gets or sets the ShowAlways.

(Inherited from
GeometryFileContainer (p. 591).)
Property Statistics (p. 593) Gets the Statistics.

(Inherited from
GeometryFileContainer (p. 591).)
Property Suppressed (p. 593) Gets or sets the Suppressed.

(Inherited from
GeometryFileContainer (p. 591).)
Property TranslateX (p. 1172) Gets or sets the TranslateX.
Property TranslateY (p. 1172) Gets or sets the TranslateY.
Property TranslateZ (p. 1172) Gets or sets the TranslateZ.
Method ExportStl(string, Progress) (p. 1172)Export STL data.

Color
Gets or sets the Color.

Declaration Syntax
public int Color { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FileName
Gets or sets the FileName.

Declaration Syntax
public string FileName { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1171
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSGeometryFileContainerAuto InternalObject { get; }

TranslateX
Gets or sets the TranslateX.

Declaration Syntax
public double TranslateX { set;get; }

TranslateY
Gets or sets the TranslateY.

Declaration Syntax
public double TranslateY { set;get; }

TranslateZ
Gets or sets the TranslateZ.

Declaration Syntax
public double TranslateZ { set;get; }

ExportStl(string, Progress)
Export STL data.

Declaration Syntax
public virtual void ExportStl(string filename, Progress progress)

Parameters
filename(string)

No details are provided for this entry.

progress(Progress)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1172 of ANSYS, Inc. and its subsidiaries and affiliates.
SubstructureGenerationCondensedPart

SubstructureGenerationCondensedPart
Defines a SubstructureGenerationCondensedPart.

Declaration Syntax
public class SubstructureGenerationCondensedPart : CondensedPartBase

Table 339: Members

Property AttachmentMethod (p. 1174) Gets or sets the AttachmentMethod.


Property Children (p. 374) Gets the list of children.

(Inherited from CondensedPartBase (p. 373).)


Property Comments (p. 374) Gets the list of associated comments.

(Inherited from CondensedPartBase (p. 373).)


Property DataModelObjectCategory (p. 1174)Gets the current DataModelObject's
category.
Property Figures (p. 375) Gets the list of associated figures.

(Inherited from CondensedPartBase (p. 373).)


Property GenerateDampingMatrix (p. 1174) Gets or sets the GenerateDampingMatrix.
Property GeometrySelection (p. 375) Gets or sets the GeometrySelection.

(Inherited from CondensedPartBase (p. 373).)


Property Images (p. 375) Gets the list of associated images.

(Inherited from CondensedPartBase (p. 373).)


Property InterfaceMethod (p. 1175) Gets or sets the InterfaceMethod.
Property Interfaces (p. 1175) Returns the Interfaces of the condensed part
Property InternalObject (p. 1175) Gets the internal object. For advanced usage
only.
Property LumpedMassFormulation (p. 1175) Gets or sets the LumpedMassFormulation.
Property NumberInterfaceEntries (p. 375) Gets the NumberInterfaceEntries.

(Inherited from CondensedPartBase (p. 373).)


Property NumberMasterNodes (p. 375) Gets the NumberMasterNodes.

(Inherited from CondensedPartBase (p. 373).)


Property Physics (p. 376) Gets the Physics.

(Inherited from CondensedPartBase (p. 373).)


Property PointMassTreatment (p. 1175) Gets or sets the PointMassTreatment.
Property ReductionMethod (p. 1175) Gets or sets the ReductionMethod.
Property ReferenceTemperature (p. 376) Gets or sets the ReferenceTemperature.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1173
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from CondensedPartBase (p. 373).)


Property SolutionName (p. 376) Gets or sets the SolutionName.

(Inherited from CondensedPartBase (p. 373).)


Property SolutionNameMode (p. 376) Gets or sets the SolutionNameMode.

(Inherited from CondensedPartBase (p. 373).)


Property SolverFilesDirectory (p. 376) Gets the SolverFilesDirectory.

(Inherited from CondensedPartBase (p. 373).)


Property SolverUnits (p. 376) Gets or sets the SolverUnits.

(Inherited from CondensedPartBase (p. 373).)


Property SolverUnitSystem (p. 377) Gets or sets the SolverUnitSystem.

(Inherited from CondensedPartBase (p. 373).)


Property Suppressed (p. 377) Gets or sets the Suppressed.

(Inherited from CondensedPartBase (p. 373).)


Property TemperatureUnits (p. 377) Gets the TemperatureUnits.

(Inherited from CondensedPartBase (p. 373).)

AttachmentMethod
Gets or sets the AttachmentMethod.

Declaration Syntax
public CondensedPartCMSAttachmentMethod AttachmentMethod { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

GenerateDampingMatrix
Gets or sets the GenerateDampingMatrix.

Declaration Syntax
public YesNoProgrammedControlled GenerateDampingMatrix { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1174 of ANSYS, Inc. and its subsidiaries and affiliates.
SubstructureGenerationCondensedPart

InterfaceMethod
Gets or sets the InterfaceMethod.

Declaration Syntax
public CondensedPartInterfaceMethod InterfaceMethod { set;get; }

Interfaces
Returns the Interfaces of the condensed part

Declaration Syntax
public CondensedPartInterfaces Interfaces { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCondensedPartAuto InternalObject { get; }

LumpedMassFormulation
Gets or sets the LumpedMassFormulation.

Declaration Syntax
public CondensedPartLumpedMassFormulation LumpedMassFormulation { set;get; }

PointMassTreatment
Gets or sets the PointMassTreatment.

Declaration Syntax
public CondensedPartPointMassTreatment PointMassTreatment { set;get; }

ReductionMethod
Gets or sets the ReductionMethod.

Declaration Syntax
public CondensedPartReductionMethod ReductionMethod { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1175
Ansys.ACT.Automation.Mechanical Namespace

Surface
Defines a Surface.

Declaration Syntax
public class Surface : DataModelObject, ISelectionInfo, IFolderDataModelObject

Table 340: Members

Property Children (p. 1176) Gets the list of children.


Property Comments (p. 1176) Gets the list of associated comments.
Property CoordinateSystem (p. 1177) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1177) Gets the current DataModelObject's category.
Property Figures (p. 1177) Gets the list of associated figures.
Property Images (p. 1177) Gets the list of associated images.
Property InternalObject (p. 1177) Gets the internal object. For advanced usage only.
Property Suppressed (p. 1177) Gets or sets the Suppressed.
Method AddComment() (p. 1178) Creates a new child Comment.
Method AddFigure() (p. 1178) Creates a new child Figure.
Method AddImage(string) (p. 1178) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1178) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1178)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1179)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1176 of ANSYS, Inc. and its subsidiaries and affiliates.
Surface

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSurfaceAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1177
Ansys.ACT.Automation.Mechanical Namespace

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1178 of ANSYS, Inc. and its subsidiaries and affiliates.
SurfaceCoating

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

SurfaceCoating
Defines a SurfaceCoating.

Declaration Syntax
public class SurfaceCoating : ImportedDataModelObject, IFolderDataModelObject

Table 341: Members

Property Children (p. 1180) Gets the list of children.


Property Comments (p. 1180) Gets the list of associated comments.
Property CoordinateSystem (p. 1180) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1181) Gets the current DataModelObject's category.
Property Figures (p. 1181) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1179
Ansys.ACT.Automation.Mechanical Namespace

Property Images (p. 1181) Gets the list of associated images.


Property InternalObject (p. 1181) Gets the internal object. For advanced usage only.
Property Location (p. 1181) Gets or sets the Location.
Property Material (p. 1181) Gets or sets the Material.
Property Suppressed (p. 1182) Gets or sets the Suppressed.
Property SurfaceCoatingStiffnessBehavior (p. 1182)Gets or sets the SurfaceCoatingStiffnessBehavior.
Property Thickness (p. 1182) Gets or sets the Thickness.
Method AddComment() (p. 1182) Creates a new child Comment.
Method AddFigure() (p. 1182) Creates a new child Figure.
Method AddImage(string) (p. 1182) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1183) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1183)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1183)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1180 of ANSYS, Inc. and its subsidiaries and affiliates.
SurfaceCoating

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSurfaceCoatingAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1181
Ansys.ACT.Automation.Mechanical Namespace

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

SurfaceCoatingStiffnessBehavior
Gets or sets the SurfaceCoatingStiffnessBehavior.

Declaration Syntax
public SurfaceCoatingStiffnessBehavior SurfaceCoatingStiffnessBehavior { set;get; }

Thickness
Gets or sets the Thickness.

Declaration Syntax
public Quantity Thickness { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1182 of ANSYS, Inc. and its subsidiaries and affiliates.
SurfaceCoating

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1183
Ansys.ACT.Automation.Mechanical Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Symmetry
Defines a Symmetry.

Declaration Syntax
public class Symmetry : ImportedDataModelObject, IFolderDataModelObject

Table 342: Members

Property Children (p. 1185) Gets the list of children.


Property Comments (p. 1185) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1185) Gets the current DataModelObject's category.
Property Figures (p. 1185) Gets the list of associated figures.
Property Images (p. 1185) Gets the list of associated images.
Property InternalObject (p. 1185) Gets the internal object. For advanced usage only.
Method AddComment() (p. 1186) Creates a new child Comment.
Method AddCyclicRegion() (p. 1186) Creates a new CyclicRegion
Method AddFigure() (p. 1186) Creates a new child Figure.
Method AddGeneralAxisymmetric() (p. 1186) Creates a new GeneralAxisymmetric
Method AddImage(string) (p. 1186) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddLinearPeriodicRegion() (p. 1187) Creates a new SymmetryRegion
Method AddPeriodicRegion() (p. 1187) Creates a new PeriodicRegion
Method AddPreMeshedCyclicRegion() (p. 1187) Creates a new PreMeshedCyclicRegion
Method AddStage() (p. 1187) Creates a new Stage
Method AddSymmetryRegion() (p. 1187) Creates a new SymmetryRegion
Method Delete() (p. 1187) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1188)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1188)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1184 of ANSYS, Inc. and its subsidiaries and affiliates.
Symmetry

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGroupAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1185
Ansys.ACT.Automation.Mechanical Namespace

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCyclicRegion()
Creates a new CyclicRegion

Declaration Syntax
public virtual CyclicRegion AddCyclicRegion()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddGeneralAxisymmetric()
Creates a new GeneralAxisymmetric

Declaration Syntax
public virtual GeneralAxisymmetric AddGeneralAxisymmetric()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1186 of ANSYS, Inc. and its subsidiaries and affiliates.
Symmetry

AddLinearPeriodicRegion()
Creates a new SymmetryRegion

Declaration Syntax
public virtual SymmetryRegion AddLinearPeriodicRegion()

AddPeriodicRegion()
Creates a new PeriodicRegion

Declaration Syntax
public virtual PeriodicRegion AddPeriodicRegion()

AddPreMeshedCyclicRegion()
Creates a new PreMeshedCyclicRegion

Declaration Syntax
public virtual PreMeshedCyclicRegion AddPreMeshedCyclicRegion()

AddStage()
Creates a new Stage

Declaration Syntax
public virtual Stage AddStage()

AddSymmetryRegion()
Creates a new SymmetryRegion

Declaration Syntax
public virtual SymmetryRegion AddSymmetryRegion()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1187
Ansys.ACT.Automation.Mechanical Namespace

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

SymmetryGeneral
Defines a SymmetryGeneral.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1188 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryGeneral

Declaration Syntax
public class SymmetryGeneral : ImportedDataModelObject, IFolderDataModelObject

Table 343: Members

Property Children (p. 1189) Gets the list of children.


Property Comments (p. 1189) Gets the list of associated comments.
Property CoordinateSystem (p. 1190) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1190) Gets the current DataModelObject's category.
Property Figures (p. 1190) Gets the list of associated figures.
Property HighBoundaryLocation (p. 1190) Gets or sets the HighBoundaryLocation.
Property Images (p. 1190) Gets the list of associated images.
Property InternalObject (p. 1190) Gets the internal object. For advanced usage only.
Property Location (p. 1191) Gets or sets the Location.
Property LowBoundaryLocation (p. 1191) Gets or sets the LowBoundaryLocation.
Property ScopeMode (p. 1191) Gets the ScopeMode.
Property Suppressed (p. 1191) Gets or sets the Suppressed.
Method AddComment() (p. 1191) Creates a new child Comment.
Method AddFigure() (p. 1191) Creates a new child Figure.
Method AddImage(string) (p. 1192) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1192) Run the Delete action.
Method FlipHighLow() (p. 1192) Flips the High and Low Boundaries.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1192)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1193)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1189
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

HighBoundaryLocation
Gets or sets the HighBoundaryLocation.

Declaration Syntax
public ISelectionInfo HighBoundaryLocation { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1190 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryGeneral

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

LowBoundaryLocation
Gets or sets the LowBoundaryLocation.

Declaration Syntax
public ISelectionInfo LowBoundaryLocation { set;get; }

ScopeMode
Gets the ScopeMode.

Declaration Syntax
public AutomaticOrManual ScopeMode { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1191
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

FlipHighLow()
Flips the High and Low Boundaries.

Declaration Syntax
public virtual void FlipHighLow()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1192 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryManufacturingConstraint

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

SymmetryManufacturingConstraint
Defines a SymmetryManufacturingConstraint.

Declaration Syntax
public class SymmetryManufacturingConstraint : ManufacturingConstraint

Table 344: Members

Property Axis (p. 1194) Gets or sets the Axis.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 1194) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1194)Gets the current DataModelObject's
category.
Property InternalObject (p. 1194) Gets the internal object. For advanced usage
only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1193
Ansys.ACT.Automation.Mechanical Namespace

Property Location (p. 1194) Gets or sets the Location.


Property ScopingMethod (p. 1195) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1194 of ANSYS, Inc. and its subsidiaries and affiliates.
SymmetryRegion

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SymmetryRegion
Defines a SymmetryRegion.

Declaration Syntax
public class SymmetryRegion : SymmetryGeneral

Table 345: Members

Property ApplyTo (p. 1196) Gets or sets the ApplyTo.


Property Behavior (p. 1196) Gets or sets the Behavior.
Property Children (p. 1189) Gets the list of children.

(Inherited from SymmetryGeneral (p. 1188).)


Property Comments (p. 1189) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1188).)


Property CoordinateSystem (p. 1190) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1188).)


Property DataModelObjectCategory (p. 1196)Gets the current DataModelObject's
category.
Property Figures (p. 1190) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1188).)


Property HighBoundaryLocation (p. 1190) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property Images (p. 1190) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1188).)


Property InternalObject (p. 1196) Gets the internal object. For advanced usage
only.
Property LinearShift (p. 1197) Gets or sets the LinearShift.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1195
Ansys.ACT.Automation.Mechanical Namespace

Property Location (p. 1197) Gets or sets the Location.


Property LowBoundaryLocation (p. 1191) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1188).)


Property PeriodicityDirection (p. 1197) Gets or sets the PeriodicityDirection.
Property ScopeMode (p. 1191) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1188).)


Property Suppressed (p. 1191) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1188).)


Property SymmetryNormal (p. 1197) Gets or sets the SymmetryNormal.
Property Type (p. 1197) Gets or sets the Type.

ApplyTo
Gets or sets the ApplyTo.

Declaration Syntax
public PeriodicApplyTo ApplyTo { set;get; }

Behavior
Gets or sets the Behavior.

Declaration Syntax
public SymmetryBehavior Behavior { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSSymmetryGeneralAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1196 of ANSYS, Inc. and its subsidiaries and affiliates.
Table

LinearShift
Gets or sets the LinearShift.

Declaration Syntax
public Quantity LinearShift { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

PeriodicityDirection
Gets or sets the PeriodicityDirection.

Declaration Syntax
public PeriodicityDirectionType PeriodicityDirection { set;get; }

SymmetryNormal
Gets or sets the SymmetryNormal.

Declaration Syntax
public SymmetryNormalType SymmetryNormal { set;get; }

Type
Gets or sets the Type.

Declaration Syntax
public SymmetryRegionType Type { set;get; }

Table
Defines a Table.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1197
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class Table : DataModelObject, IDataTable, IEnumerable<IDataSeries>, IEnumerable, IRemov-
ableDataModelObject, IRecordableProperties, IFolderDataModelObject

Table 346: Members

Property APDLName (p. 1199) Gets or sets the name of the Table when explicitly written to the
Property Children (p. 1199) Gets the list of children.
Property Comments (p. 1199) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1199) Gets the current DataModelObject's category.
Property Figures (p. 1199) Gets the list of associated figures.
Property Images (p. 1200) Gets the list of associated images.
Property InternalObject (p. 1200) Gets the internal object. For advanced usage only.
Property IsStrictSizing (p. 1200) Whether column add/create/import/refresh operations cannot gro

(See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) will alw

When (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing)


and adding a column, importing columns.
Property PathType (p. 1200) Gets or sets the PathType.
Property RefreshImportOn (p. 1200) Gets or sets the RefreshImportOn.
Property SendToSolver (p. 1201) Get whether the Table will be explicitly written to the APDL input
Property SpatialCoordinateSystem (p. 1201) Gets or sets the coordinate system applied to the Table’s spatial in
Method AddComment() (p. 1201) Creates a new child Comment.
Method AddFigure() (p. 1201) Creates a new child Figure.
Method AddImage(string) (p. 1201) Creates a new child Image. If a filePath is provided, the image will
Method CreateAndAddColumn(VariableType, Creates and adds a new column (data series) to the table.
VariableClassification, IEnumerable,
string, string) (p. 1202) If `data` is provided, the number of rows (length of `data`) must b
the same number of rows as the table with default-initialized valu
to the length of `data`.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1202)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1203)
Method GetDataURI(Column) (p. 1203) Gets the data URI from which the tabular data was imported.
Method GetImportSettings(Column) (p. 1204) Get the settings used for an import operation.
Method Import(string, ImportFormat, Import data from the provided resource into the table as specified
ImportSettingsBase) (p. 1204) column. If the table already contains a variable type, that column

When (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing)


Ansys.ACT.Automation.Mechanical.Table.Import(System.String,Ansy
will verify that the row count of imported data are equivalent to t
Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) is false, a M
table.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1198 of ANSYS, Inc. and its subsidiaries and affiliates.
Table

If all the arguments are `null` (Python: `None`) then the stored val
NestedType Column (p. 1205) This class represents one Ansys.Core.Units.Quantity-based data co

The individual values may be set, but the length of the series is fix
Ansys.ACT.Automation.Mechanical.Table.Column) instances by the

APDLName
Gets or sets the name of the Table when explicitly written to the APDL input file.

Declaration Syntax
public string APDLName { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1199
Ansys.ACT.Automation.Mechanical Namespace

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTableAuto InternalObject { get; }

IsStrictSizing
Whether column add/create/import/refresh operations cannot grow the number of rows.

(See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) will always be `true` when (See An-


sys.ACT.Automation.Mechanical.Table.IsReadOnly) is `true`.

When (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) is `true`, any operation that would


change the table row count will fail. This includes operations such as creating and adding a column,
importing columns.

Declaration Syntax
public bool IsStrictSizing { set;get; }

PathType
Gets or sets the PathType.

Declaration Syntax
public PathType PathType { set;get; }

RefreshImportOn
Gets or sets the RefreshImportOn.

Declaration Syntax
public TableRefreshImportOn RefreshImportOn { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1200 of ANSYS, Inc. and its subsidiaries and affiliates.
Table

SendToSolver
Get whether the Table will be explicitly written to the APDL input file.

Declaration Syntax
public bool SendToSolver { set;get; }

SpatialCoordinateSystem
Gets or sets the coordinate system applied to the Table’s spatial independent columns.

Declaration Syntax
public CoordinateSystem SpatialCoordinateSystem { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1201
Ansys.ACT.Automation.Mechanical Namespace

CreateAndAddColumn(VariableType, VariableClassification, IEnumerable,


string, string)
Creates and adds a new column (data series) to the table.

If `data` is provided, the number of rows (length of `data`) must be identical to the number of rows
already in the table. If `data` is not provided, the returned series will have the same number of rows
as the table with default-initialized values. If there are no rows in the table and `data` is provided,
this will initialize the number of rows in the table to the length of `data`.

Declaration Syntax
public virtual IDataSeries CreateAndAddColumn(VariableType variableType, VariableClassification
variableClassification, IEnumerable data, string unit, string name)

Parameters
variableType(VariableType)

The

of the new column.

variableClassification(VariableClassification)

The

of the new column.

data(IEnumerable)

The values, if any, for the new column. If `null`, a default value of

will be used.

unit(string)

The unit of the data. If `null`, a default unit will be selected for the specified

name(string)

The name of the new column. If `null`, a unique name will be generated from the specified

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1202 of ANSYS, Inc. and its subsidiaries and affiliates.
Table

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetDataURI(Column)
Gets the data URI from which the tabular data was imported.

Declaration Syntax
public virtual string GetDataURI(Column newColumn)

Parameters
newColumn(Column)

The

for which the settings are to be fetched.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1203
Ansys.ACT.Automation.Mechanical Namespace

GetImportSettings(Column)
Get the settings used for an import operation.

Declaration Syntax
public virtual ImportSettingsBase GetImportSettings(Column newColumn)

Parameters
newColumn(Column)

The

for which the settings are to be fetched.

Import(string, ImportFormat, ImportSettingsBase)


Import data from the provided resource into the table as specified by format and settings. The column
definitions in settings will be used to define the variable type for each column. If the table already
contains a variable type, that column will be overwritten by the new definition.

When (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) is true, (See Ansys.ACT.Automa-


tion.Mechanical.Table.Import(System.String,Ansys.Mechanical.DataModel.MechanicalEnums.Table.Im-
portFormat,Ansys.Mechanical.Table.ImportSettingsBase)) (p. 1204) will verify that the row count of im-
ported data are equivalent to the existing table row count. The operation will fail if there is a length
mismatch. Conversely, when (See Ansys.ACT.Automation.Mechanical.Table.IsStrictSizing) is false, a
Mechanical warning message will be issued when any of the data sources are different from each
other or the table.

If all the arguments are `null` (Python: `None`) then the stored values will be used, essentially re-
syncing the table data to the external sources.

Declaration Syntax
public virtual IList<IDataSeries> Import(string dataURI, ImportFormat format, ImportSettingsBase
settings)

Parameters
dataURI(string)

The URI of the data source to import.

format(ImportFormat)

The format of the data source.

settings(ImportSettingsBase)

The settings for how to import.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1204 of ANSYS, Inc. and its subsidiaries and affiliates.
Table

Column
This class represents one Ansys.Core.Units.Quantity-based data column in a (See Ansys.ACT.Automa-
tion.Mechanical.Table) (p. 1197).

The individual values may be set, but the length of the series is fixed. Any changes to the number of
rows must be made in conjunction with any sibling (See Ansys.ACT.Automation.Mechanic-
al.Table.Column) instances by the parent (See Ansys.Mechanical.Interfaces.IDataTable) (p. 4604).

Declaration Syntax
public class Column

Table 347: Members

Event PropertyChanged (p. 1205) No details are provided for this entry.
Method Add(object) (p. 1205) No details are provided for this entry.
Method ChangeVariableType(VariableType, Contains the business logic for changing the
VariableClassification, string) (p. 1206) variable type.
Method Clear() (p. 1206) No details are provided for this entry.
Method Contains(object) (p. 1206) No details are provided for this entry.
Method CopyTo(Array, int) (p. 1207) No details are provided for this entry.
Method GetEnumerator() (p. 1207) No details are provided for this entry.
Method IndexOf(object) (p. 1207) No details are provided for this entry.
Method Insert(int, object) (p. 1207) No details are provided for this entry.
Method Remove(object) (p. 1208) No details are provided for this entry.
Method RemoveAt(int) (p. 1208) No details are provided for this entry.

PropertyChanged
No details are provided for this entry.

Declaration Syntax
public PropertyChangedEventHandler PropertyChanged

Add(object)
No details are provided for this entry.

Declaration Syntax
public virtual int Add(object value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1205
Ansys.ACT.Automation.Mechanical Namespace

Parameters
value(object)

No details are provided for this entry.

ChangeVariableType(VariableType, VariableClassification, string)


Contains the business logic for changing the variable type.

Declaration Syntax
public bool ChangeVariableType(VariableType newVariableType, VariableClassification newVariable-
Classification, string newUnit)

Parameters
newVariableType(VariableType)

The new variable type.

newVariableClassification(VariableClassification)

The new variable classification.

newUnit(string)

The new unit.

Clear()
No details are provided for this entry.

Declaration Syntax
public virtual void Clear()

Contains(object)
No details are provided for this entry.

Declaration Syntax
public virtual bool Contains(object value)

Parameters
value(object)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1206 of ANSYS, Inc. and its subsidiaries and affiliates.
Table

CopyTo(Array, int)
No details are provided for this entry.

Declaration Syntax
public virtual void CopyTo(Array array, int destinationStartIndex)

Parameters
array(Array)

No details are provided for this entry.

destinationStartIndex(int)

No details are provided for this entry.

GetEnumerator()
No details are provided for this entry.

Declaration Syntax
public virtual IEnumerator GetEnumerator()

IndexOf(object)
No details are provided for this entry.

Declaration Syntax
public virtual int IndexOf(object value)

Parameters
value(object)

No details are provided for this entry.

Insert(int, object)
No details are provided for this entry.

Declaration Syntax
public virtual void Insert(int index, object value)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1207
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

No details are provided for this entry.

value(object)

No details are provided for this entry.

Remove(object)
No details are provided for this entry.

Declaration Syntax
public virtual void Remove(object value)

Parameters
value(object)

No details are provided for this entry.

RemoveAt(int)
No details are provided for this entry.

Declaration Syntax
public virtual void RemoveAt(int index)

Parameters
index(int)

No details are provided for this entry.

TableGroup
Defines a TableGroup.

Declaration Syntax
public class TableGroup : DataModelObject, IRemovableDataModelObject, IFolderDataModelObject

Table 348: Members

Property Children (p. 1209) Gets the list of children.


Property Comments (p. 1209) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1209) Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1208 of ANSYS, Inc. and its subsidiaries and affiliates.
TableGroup

Property Figures (p. 1209) Gets the list of associated figures.


Property Images (p. 1210) Gets the list of associated images.
Property InternalObject (p. 1210) Gets the internal object. For advanced usage only.
Method AddComment() (p. 1210) Creates a new child Comment.
Method AddFigure() (p. 1210) Creates a new child Figure.
Method AddImage(string) (p. 1210) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method AddTable(bool, bool) (p. 1211) Create the object for working with an imported
part.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1211)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1211)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1209
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTableGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1210 of ANSYS, Inc. and its subsidiaries and affiliates.
TableGroup

Parameters
filePath(string)

Full path of file. Defaults to None.

AddTable(bool, bool)
Create the object for working with an imported part.

Declaration Syntax
public virtual Table AddTable(bool activate, bool expandGroup)

Parameters
activate(bool)

Whether the new Table should become the active object after creation.

expandGroup(bool)

If

is false, specifies whether the Tables group should be expanded after adding a new Table.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1211
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

TCrossSection
Defines a TCrossSection.

Declaration Syntax
public class TCrossSection : CrossSection

Table 349: Members

Property Area (p. 1213) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 1213)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 1213) Gets the internal object. For advanced usage
only.
Property IYY (p. 1213) Gets the IYY.
Property IZZ (p. 1213) Gets the IZZ.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1212 of ANSYS, Inc. and its subsidiaries and affiliates.
TCrossSection

Property Thick1 (p. 1214) Gets or sets the Thick1.


Property Thick2 (p. 1214) Gets or sets the Thick2.
Property Width1 (p. 1214) Gets or sets the Width1.
Property Width2 (p. 1214) Gets or sets the Width2.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1213
Ansys.ACT.Automation.Mechanical Namespace

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Declaration Syntax
public Quantity Thick2 { set;get; }

Width1
Gets or sets the Width1.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

TemperatureConstraint
Defines a TemperatureConstraint.

Declaration Syntax
public class TemperatureConstraint : ResponseConstraint

Table 350: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 1215)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1214 of ANSYS, Inc. and its subsidiaries and affiliates.
TemperatureConstraint

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 1215) Gets the internal object. For advanced usage only.
Property Location (p. 1215) Gets or sets the Location.
Property ScopingMethod (p. 1215) Gets or sets the ScopingMethod.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)


Property TemperatureAbsMax (p. 1215) Gets or sets the TemperatureAbsMax.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

TemperatureAbsMax
Gets or sets the TemperatureAbsMax.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1215
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Field TemperatureAbsMax { get; }

ThermalComplianceConstraint
Defines a ThermalComplianceConstraint.

Declaration Syntax
public class ThermalComplianceConstraint : ResponseConstraint

Table 351: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property ComplianceLimit (p. 1216) Gets or sets the ComplianceLimit.
Property DataModelObjectCategory (p. 1216)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 1216) Gets the internal object. For advanced usage only.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

ComplianceLimit
Gets or sets the ComplianceLimit.

Declaration Syntax
public Field ComplianceLimit { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1216 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalPointMass

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

ThermalPointMass
Defines a ThermalPointMass.

Declaration Syntax
public class ThermalPointMass : GenericPointMass

Table 352: Members

Property AppliedBy (p. 1218) Gets or sets the AppliedBy.


Property Behavior (p. 1218) Gets or sets the Behavior.
Property Children (p. 568) Gets the list of children.

(Inherited from GenericPointMass (p. 568).)


Property Comments (p. 569) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 568).)


Property CoordinateSystem (p. 1218) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1218)Gets the current DataModelObject's category.
Property Figures (p. 569) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 568).)


Property Images (p. 569) Gets the list of associated images.

(Inherited from GenericPointMass (p. 568).)


Property InternalObject (p. 1218) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 569) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 568).)


Property Location (p. 570) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 568).)


Property PinballRegion (p. 1218) Gets or sets the PinballRegion.
Property RemotePoint (p. 570) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 568).)


Property Suppressed (p. 1219) Gets or sets the Suppressed.
Property ThermalCapacitance (p. 1219) Gets or sets the ThermalCapacitance.
Property XCoordinate (p. 1219) Gets or sets the XCoordinate.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1217
Ansys.ACT.Automation.Mechanical Namespace

Property YCoordinate (p. 1219) Gets or sets the YCoordinate.


Property ZCoordinate (p. 1219) Gets or sets the ZCoordinate.
Method PromoteToRemotePoint() (p. 1219) Run the PromoteToRemotePoint action.

AppliedBy
Gets or sets the AppliedBy.

Declaration Syntax
public RemoteApplicationType AppliedBy { set;get; }

Behavior
Gets or sets the Behavior.

Declaration Syntax
public ThermalPointMassBehavior Behavior { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPointMassAuto InternalObject { get; }

PinballRegion
Gets or sets the PinballRegion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1218 of ANSYS, Inc. and its subsidiaries and affiliates.
ThermalPointMass

Declaration Syntax
public Quantity PinballRegion { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ThermalCapacitance
Gets or sets the ThermalCapacitance.

Declaration Syntax
public Quantity ThermalCapacitance { set;get; }

XCoordinate
Gets or sets the XCoordinate.

Declaration Syntax
public Quantity XCoordinate { set;get; }

YCoordinate
Gets or sets the YCoordinate.

Declaration Syntax
public Quantity YCoordinate { set;get; }

ZCoordinate
Gets or sets the ZCoordinate.

Declaration Syntax
public Quantity ZCoordinate { set;get; }

PromoteToRemotePoint()
Run the PromoteToRemotePoint action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1219
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual IEnumerable<RemotePoint> PromoteToRemotePoint()

Thickness
Defines a Thickness.

Declaration Syntax
public class Thickness : ImportedDataModelObject, IFolderDataModelObject

Table 353: Members

Property Children (p. 1221) Gets the list of children.


Property Comments (p. 1221) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1221) Gets the current DataModelObject's category.
Property Figures (p. 1221) Gets the list of associated figures.
Property Images (p. 1221) Gets the list of associated images.
Property IndependentVariable (p. 1221) Gets or sets the IndependentVariable.
Property InternalObject (p. 1222) Gets the internal object. For advanced usage only.
Property Location (p. 1222) Gets or sets the Location.
Property MembraneOffset (p. 1222) Gets or sets the MembraneOffset.
Property NumberOfSegments (p. 1222) Gets or sets the NumberOfSegments.
Property OffsetType (p. 1222) Gets or sets the OffsetType.
Property RangeMaximum (p. 1222) Gets or sets the RangeMaximum.
Property RangeMinimum (p. 1223) Gets or sets the RangeMinimum.
Property ScopeMode (p. 1223) Gets the ScopeMode.
Property Suppressed (p. 1223) Gets or sets the Suppressed.
Property ThicknessField (p. 1223) Gets or sets the ThicknessField.
Property XYZFunctionCoordinateSystem (p. 1223) Gets or sets the XYZFunctionCoordinateSystem.
Method AddComment() (p. 1223) Creates a new child Comment.
Method AddFigure() (p. 1224) Creates a new child Figure.
Method AddImage(string) (p. 1224) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1224) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1224)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1225)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1220 of ANSYS, Inc. and its subsidiaries and affiliates.
Thickness

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

IndependentVariable
Gets or sets the IndependentVariable.

Declaration Syntax
public LoadVariableVariationType IndependentVariable { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1221
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSThicknessAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MembraneOffset
Gets or sets the MembraneOffset.

Declaration Syntax
public Quantity MembraneOffset { set;get; }

NumberOfSegments
Gets or sets the NumberOfSegments.

Declaration Syntax
public int NumberOfSegments { set;get; }

OffsetType
Gets or sets the OffsetType.

Declaration Syntax
public ShellOffsetType OffsetType { set;get; }

RangeMaximum
Gets or sets the RangeMaximum.

Declaration Syntax
public Quantity RangeMaximum { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1222 of ANSYS, Inc. and its subsidiaries and affiliates.
Thickness

RangeMinimum
Gets or sets the RangeMinimum.

Declaration Syntax
public Quantity RangeMinimum { set;get; }

ScopeMode
Gets the ScopeMode.

Declaration Syntax
public AutomaticOrManual ScopeMode { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

ThicknessField
Gets or sets the ThicknessField.

Declaration Syntax
public Field ThicknessField { get; }

XYZFunctionCoordinateSystem
Gets or sets the XYZFunctionCoordinateSystem.

Declaration Syntax
public CoordinateSystem XYZFunctionCoordinateSystem { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1223
Ansys.ACT.Automation.Mechanical Namespace

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1224 of ANSYS, Inc. and its subsidiaries and affiliates.
ThroughCrack

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ThroughCrack
Defines a ThroughCrack.

Declaration Syntax
public class ThroughCrack : GenericCrack

Table 354: Members

Property BottomFaceNodes (p. 1226) Gets or sets the BottomFaceNodes.


Property Children (p. 561) Gets the list of children.

(Inherited from GenericCrack (p. 560).)


Property CircumferentialDivisions (p. 1227) Gets or sets the CircumferentialDivisions.
Property Comments (p. 561) Gets the list of associated comments.

(Inherited from GenericCrack (p. 560).)


Property Contact1Nodes (p. 1227) Gets or sets the Contact1Nodes.
Property ContactPairsNodes (p. 1227) Gets or sets the ContactPairsNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1225
Ansys.ACT.Automation.Mechanical Namespace

Property CoordinateSystem (p. 1227) Gets or sets the CoordinateSystem.


Property CrackFacesNodes (p. 1227) Gets or sets the CrackFacesNodes.
Property CrackFrontDivisions (p. 1227) Gets or sets the CrackFrontDivisions.
Property CrackFrontNodes (p. 1228) Gets or sets the CrackFrontNodes.
Property CrackID (p. 561) Gets the CrackID.

(Inherited from GenericCrack (p. 560).)


Property CrackMeshMethod (p. 1228) Gets or sets the CrackMeshMethod.
Property CrackShape (p. 1228) Gets the CrackShape.
Property CrackSourceType (p. 1228) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 1228) Gets the current DataModelObject's
category.
Property Depth (p. 1228) Gets or sets the Depth.
Property EndWidth (p. 1229) Gets or sets the EndWidth.
Property Figures (p. 562) Gets the list of associated figures.

(Inherited from GenericCrack (p. 560).)


Property FractureAffectedZone (p. 1229) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 1229)Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 1229) Gets or sets the FrontElementSize.
Property GrowthRate (p. 1229) Gets or sets the GrowthRate.
Property Images (p. 562) Gets the list of associated images.

(Inherited from GenericCrack (p. 560).)


Property InternalObject (p. 1229) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 1230) Gets or sets the LargestContourRadius.
Property Location (p. 1230) Gets or sets the Location.
Property MeshContours (p. 1230) Gets or sets the MeshContours.
Property MidWidth (p. 1230) Gets or sets the MidWidth.
Property SolutionContours (p. 1230) Gets or sets the SolutionContours.
Property StartWidth (p. 1230) Gets or sets the StartWidth.
Property Suppressed (p. 1231) Gets or sets the Suppressed.
Property Target1Nodes (p. 1231) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 1231) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 1231) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 1231) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 1231) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1226 of ANSYS, Inc. and its subsidiaries and affiliates.
ThroughCrack

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Declaration Syntax
public int CircumferentialDivisions { set;get; }

Contact1Nodes
Gets or sets the Contact1Nodes.

Declaration Syntax
public string Contact1Nodes { set;get; }

ContactPairsNodes
Gets or sets the ContactPairsNodes.

Declaration Syntax
public bool ContactPairsNodes { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFacesNodes
Gets or sets the CrackFacesNodes.

Declaration Syntax
public bool CrackFacesNodes { set;get; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1227
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int CrackFrontDivisions { set;get; }

CrackFrontNodes
Gets or sets the CrackFrontNodes.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Declaration Syntax
public CrackMeshMethod CrackMeshMethod { set;get; }

CrackShape
Gets the CrackShape.

Declaration Syntax
public CrackShapeType CrackShape { get; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Depth
Gets or sets the Depth.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1228 of ANSYS, Inc. and its subsidiaries and affiliates.
ThroughCrack

Declaration Syntax
public Quantity Depth { set;get; }

EndWidth
Gets or sets the EndWidth.

Declaration Syntax
public Quantity EndWidth { set;get; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Declaration Syntax
public FractureAffectedZone FractureAffectedZone { set;get; }

FractureAffectedZoneHeight
Gets or sets the FractureAffectedZoneHeight.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Declaration Syntax
public Quantity FrontElementSize { set;get; }

GrowthRate
Gets or sets the GrowthRate.

Declaration Syntax
public double GrowthRate { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1229
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MeshContours
Gets or sets the MeshContours.

Declaration Syntax
public int MeshContours { set;get; }

MidWidth
Gets or sets the MidWidth.

Declaration Syntax
public Quantity MidWidth { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Declaration Syntax
public int SolutionContours { set;get; }

StartWidth
Gets or sets the StartWidth.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1230 of ANSYS, Inc. and its subsidiaries and affiliates.
ThroughCrack

Declaration Syntax
public Quantity StartWidth { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Target1Nodes
Gets or sets the Target1Nodes.

Declaration Syntax
public string Target1Nodes { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public string TopFaceNodes { set;get; }

XScaleFactor
Gets or sets the XScaleFactor.

Declaration Syntax
public double XScaleFactor { set;get; }

YScaleFactor
Gets or sets the YScaleFactor.

Declaration Syntax
public double YScaleFactor { set;get; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1231
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double ZScaleFactor { set;get; }

Tree
No details are provided for this entry.

Declaration Syntax
public class Tree : ACTMarshalByRefObject, IEnumerable

Table 355: Members

Property ActiveObjects (p. 1233) Gets a list of all selected objects.


Property AllObjects (p. 1233) Gets a list of all objects available in the tree.
Property CurrentFilter (p. 1233) Gets the current filter applied on the tree.
Property CurrentSearchGraphics (p. 1233) Gets the current visibility.
Property CurrentSearchState (p. 1233) Gets the current search state.
Property CurrentSearchString (p. 1234) Gets the current search string (name/tag/propertyName/p
Property FirstActiveObject (p. 1234) Gets the first object selected in the tree.
Property GroupingFoldersVisible (p. 1234) Controls whether or not group folders are visible.
Method Activate(IDataModelObject) (p. 1234) selects an object in the tree.
Method Activate(IEnumerable<IDataModelObject>) (p. 1234)Multi-selects a list of objects in the tree.
Method ClearFilter() (p. 1235) Clears the current filter.
Method ClearSort() (p. 1235) Clears the current sort.
Method Filter(string, string, ObjectState, VisibilityType, Filters the tree objects based on given parameters.
TreeFilterObjectClass, CoordinateSystem, string,
Analysis, TreeFilterScopingType,
TreeFilterObjectState, string, string,
Nullable<bool>) (p. 1235)
Method Find(string, Func<IDataModelObject, bool>, Gets a list of all objects with the specified parameters.
string, ObjectState) (p. 1236)
Method GetPathToFirstActiveObject() (p. 1237) Gets the full path that needs to be typed in order to go to
Method Group(IDataModelObject) (p. 1237) Moves dataModelObject to new tree grouping folder.
Method Group(IEnumerable) (p. 1237) Groups a list of objects together.
Method IsSorted() (p. 1238) Checks if the tree is currently sorted alphabetically.
Method Refresh() (p. 1238) Refreshes the tree.
Method Sort(SortingType, bool) (p. 1238) Sorts the tree objects based on given parameters.

Type of sorting to apply.

Wheter to sort in reverse order.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1232 of ANSYS, Inc. and its subsidiaries and affiliates.
Tree

Note that all parameters of Sort are optional. type: Default


Defaults to false sorting in reverse order is currently not su
Usage example - sort alphabetically
ExtAPI.DataModel.Tree.Sort()

Usage example - sort alphabetically


ExtAPI.DataModel.Tree.Sort(type=SortingTy

Method Suspend() ***OBSOLETE*** Use 'Transaction' Prevents the tree from being updated.
instead. (p. 1239)
Method Ungroup(TreeGroupingFolder) (p. 1239) Removes groupingFolder from the tree.

ActiveObjects
Gets a list of all selected objects.

Declaration Syntax
public IList<IDataModelObject> ActiveObjects { get; }

AllObjects
Gets a list of all objects available in the tree.

Declaration Syntax
public IList<IDataModelObject> AllObjects { get; }

CurrentFilter
Gets the current filter applied on the tree.

Declaration Syntax
public DSTreeSearchType CurrentFilter { get; }

CurrentSearchGraphics
Gets the current visibility.

Declaration Syntax
public VisibilityType CurrentSearchGraphics { get; }

CurrentSearchState
Gets the current search state.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1233
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public ObjectState CurrentSearchState { get; }

CurrentSearchString
Gets the current search string (name/tag/propertyName/propertyValue).

Declaration Syntax
public string CurrentSearchString { get; }

FirstActiveObject
Gets the first object selected in the tree.

Declaration Syntax
public IDataModelObject FirstActiveObject { get; }

GroupingFoldersVisible
Controls whether or not group folders are visible.

Declaration Syntax
public bool GroupingFoldersVisible { set;get; }

Activate(IDataModelObject)
selects an object in the tree.

Declaration Syntax
public void Activate(IDataModelObject dataModelObject)

Parameters
dataModelObject(IDataModelObject)

objects to select.

Activate(IEnumerable<IDataModelObject>)
Multi-selects a list of objects in the tree.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1234 of ANSYS, Inc. and its subsidiaries and affiliates.
Tree

Declaration Syntax
public void Activate(IEnumerable<IDataModelObject> dataModelObjects)

Parameters
dataModelObjects(IEnumerable<IDataModelObject>)

List of objects to select.

ClearFilter()
Clears the current filter.

Declaration Syntax
public void ClearFilter()

ClearSort()
Clears the current sort.

Declaration Syntax
public void ClearSort()

Filter(string, string, ObjectState, VisibilityType, TreeFilterObjectClass, Co-


ordinateSystem, string, Analysis, TreeFilterScopingType, TreeFilterObject-
State, string, string, Nullable<bool>)
Filters the tree objects based on given parameters.

Declaration Syntax
public void Filter(string name, string tag, ObjectState state, VisibilityType visibility, TreeFilterObjectClass
type, CoordinateSystem coordinateSystem, string model, Analysis environment, TreeFilterScopingType
scoping, TreeFilterObjectState filterState, string propertyName, string propertyValue, Nullable<bool>
invertSearchResults)

Parameters
name(string)

Filter by a given name.

tag(string)

Filter by a given tag.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1235
Ansys.ACT.Automation.Mechanical Namespace

state(ObjectState)

Filter by Suppression state.

visibility(VisibilityType)

Filter by Visibile/Invisible objects.

type(TreeFilterObjectClass)

Filter by object Type.

coordinateSystem(CoordinateSystem)

Filter by Coordinate System scoping.

model(string)

Filter by Model ("All", "Current", "Dropdown String").

environment(Analysis)

Filter by Environment.

scoping(TreeFilterScopingType)

Filter by Scoping.

filterState(TreeFilterObjectState)

Filter by object State.

propertyName(string)

Filter by Property Name.

propertyValue(string)

Filter by Property Value.

invertSearchResults(Nullable<bool>)

Flag to invert the search results.

Find(string, Func<IDataModelObject, bool>, string, ObjectState)


Gets a list of all objects with the specified parameters.

Declaration Syntax
public IEnumerable<IDataModelObject> Find(string name, Func<IDataModelObject, bool> func, string
tag, ObjectState state)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1236 of ANSYS, Inc. and its subsidiaries and affiliates.
Tree

Parameters
name(string)

The object's name.

func(Func<IDataModelObject, bool>)

The object's function.

tag(string)

The object's tag.

state(ObjectState)

The object's state.

GetPathToFirstActiveObject()
Gets the full path that needs to be typed in order to go to the selected object.

Declaration Syntax
public string GetPathToFirstActiveObject()

Group(IDataModelObject)
Moves dataModelObject to new tree grouping folder.

Declaration Syntax
public TreeGroupingFolder Group(IDataModelObject dataModelObject)

Parameters
dataModelObject(IDataModelObject)

Object in tree

Group(IEnumerable)
Groups a list of objects together.

Declaration Syntax
public TreeGroupingFolder Group(IEnumerable dataModelObjects)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1237
Ansys.ACT.Automation.Mechanical Namespace

Parameters
dataModelObjects(IEnumerable)

The list of objects to group.

IsSorted()
Checks if the tree is currently sorted alphabetically.

Declaration Syntax
public bool IsSorted()

Refresh()
Refreshes the tree.

Declaration Syntax
public void Refresh()

Sort(SortingType, bool)
Sorts the tree objects based on given parameters.

Type of sorting to apply.

Wheter to sort in reverse order.

Note that all parameters of Sort are optional. type: Defaults to alphabetical reverse: Defaults to false
sorting in reverse order is currently not supported
Usage example - sort alphabetically
ExtAPI.DataModel.Tree.Sort()

Usage example - sort alphabetically


ExtAPI.DataModel.Tree.Sort(type=SortingType.Alphabetical, reverse=False)

Declaration Syntax
public void Sort(SortingType type, bool reverse)

Parameters
type(SortingType)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1238 of ANSYS, Inc. and its subsidiaries and affiliates.
TreeGroupingFolder

reverse(bool)

No details are provided for this entry.

Suspend() ***OBSOLETE*** Use 'Transaction' instead.


Prevents the tree from being updated.

Declaration Syntax
public IDisposable Suspend()

Ungroup(TreeGroupingFolder)
Removes groupingFolder from the tree.

Declaration Syntax
public void Ungroup(TreeGroupingFolder groupingFolder)

Parameters
groupingFolder(TreeGroupingFolder)

The grouping folder in the tree

TreeGroupingFolder
Defines a TreeGroupingFolder.

Declaration Syntax
public class TreeGroupingFolder : ImportedDataModelObject, IFolderDataModelObject

Table 356: Members

Property Children (p. 1240) Gets the list of children.


Property ChildrenInGroup (p. 1240) Gets the ChildrenInGroup.
Property DataModelObjectCategory (p. 1240) Gets the current DataModelObject's
category.
Property InternalObject (p. 1240) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 1240) Gets or sets the Suppressed.
Method DeleteTreeGroupAndChildren() (p. 1240) Run the DeleteTreeGroupAndChildren
action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1241)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1239
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.


IList<IDataModelObject>) (p. 1241)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

ChildrenInGroup
Gets the ChildrenInGroup.

Declaration Syntax
public uint ChildrenInGroup { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTreeGroupingFolderAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

DeleteTreeGroupAndChildren()
Run the DeleteTreeGroupAndChildren action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1240 of ANSYS, Inc. and its subsidiaries and affiliates.
TreeGroupingFolder

Declaration Syntax
public virtual void DeleteTreeGroupAndChildren()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1241
Ansys.ACT.Automation.Mechanical Namespace

UniformConstraint
Defines a UniformConstraint.

Declaration Syntax
public class UniformConstraint : ManufacturingConstraint

Table 357: Members

Property Axis (p. 1242) Gets or sets the Axis.


Property Children (p. 703) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 702).)
Property CoordinateSystem (p. 1242) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1243)Gets the current DataModelObject's
category.
Property InternalObject (p. 1243) Gets the internal object. For advanced usage
only.
Property Location (p. 1243) Gets or sets the Location.
Property ScopingMethod (p. 1243) Gets or sets the ScopingMethod.
Property Selection (p. 703) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 702).)
Property Suppressed (p. 704) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 702).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1242 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedCrossSection

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

UserDefinedCrossSection
Defines a UserDefinedCrossSection.

Declaration Syntax
public class UserDefinedCrossSection : CrossSection

Table 358: Members

Property Area (p. 1244) Gets or sets the Area.


Property CGy (p. 1244) Gets or sets the CGy.
Property CGZ (p. 1244) Gets or sets the CGZ.
Property Children (p. 452) Gets the list of children.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1243
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 1245)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 1245) Gets the internal object. For advanced usage
only.
Property Iw (p. 1245) Gets or sets the Iw.
Property Iyy (p. 1245) Gets or sets the Iyy.
Property Izz (p. 1245) Gets or sets the Izz.
Property J (p. 1245) Gets or sets the J.
Property SHy (p. 1246) Gets or sets the SHy.
Property SHz (p. 1246) Gets or sets the SHz.

Area
Gets or sets the Area.

Declaration Syntax
public Quantity Area { set;get; }

CGy
Gets or sets the CGy.

Declaration Syntax
public Quantity CGy { set;get; }

CGZ
Gets or sets the CGZ.

Declaration Syntax
public Quantity CGZ { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1244 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedCrossSection

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

Iw
Gets or sets the Iw.

Declaration Syntax
public Quantity Iw { set;get; }

Iyy
Gets or sets the Iyy.

Declaration Syntax
public Quantity Iyy { set;get; }

Izz
Gets or sets the Izz.

Declaration Syntax
public Quantity Izz { set;get; }

J
Gets or sets the J.

Declaration Syntax
public Quantity J { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1245
Ansys.ACT.Automation.Mechanical Namespace

SHy
Gets or sets the SHy.

Declaration Syntax
public Quantity SHy { set;get; }

SHz
Gets or sets the SHz.

Declaration Syntax
public Quantity SHz { set;get; }

VirtualCell
Defines a VirtualCell.

Declaration Syntax
public class VirtualCell : DataModelObject, IFolderDataModelObject

Table 359: Members

Property Children (p. 1247) Gets the list of children.


Property Comments (p. 1247) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1247) Gets the current DataModelObject's category.
Property Figures (p. 1247) Gets the list of associated figures.
Property Geometry (p. 1247) Gets the Geometry.
Property Images (p. 1247) Gets the list of associated images.
Property InternalObject (p. 1248) Gets the internal object. For advanced usage only.
Property ProjectToUnderlyingGeometry (p. 1248) Gets or sets the ProjectToUnderlyingGeometry.
Property VTClass (p. 1248) Gets the VTClass.
Method AddComment() (p. 1248) Creates a new child Comment.
Method AddFigure() (p. 1248) Creates a new child Figure.
Method AddImage(string) (p. 1248) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1249) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1249)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1246 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualCell

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.


bool, IList<IDataModelObject>) (p. 1249)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Geometry
Gets the Geometry.

Declaration Syntax
public ISelectionInfo Geometry { get; }

Images
Gets the list of associated images.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1247
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSVirtualCellAuto InternalObject { get; }

ProjectToUnderlyingGeometry
Gets or sets the ProjectToUnderlyingGeometry.

Declaration Syntax
public YesNoType ProjectToUnderlyingGeometry { set;get; }

VTClass
Gets the VTClass.

Declaration Syntax
public VirtualCellClassType VTClass { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1248 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualCell

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1249
Ansys.ACT.Automation.Mechanical Namespace

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

VirtualTopology
Defines a VirtualTopology.

Declaration Syntax
public class VirtualTopology : DataModelObject, IFolderDataModelObject

Table 360: Members

Property AspectRatio (p. 1252) Gets or sets the AspectRatio.


Property AutomaticBehavior (p. 1252) Gets or sets the Behavior when Method
is set to "Automatic".
Property Children (p. 1252) Gets the list of children.
Property Comments (p. 1252) Gets the list of associated comments.
Property ContactAngle (p. 1252) Gets or sets the ContactAngle.
Property CustomFeatureAngle (p. 1253) Gets or sets the CustomFeatureAngle.
Property DataModelObjectCategory (p. 1253) Gets the current DataModelObject's
category.
Property EdgeAngle (p. 1253) Gets or sets the EdgeAngle.
Property Figures (p. 1253) Gets the list of associated figures.
Property GaussAngle (p. 1253) Gets or sets the GaussAngle.
Property GenerateOnUpdate (p. 1253) Gets or sets the GenerateOnUpdate.
Property Images (p. 1254) Gets the list of associated images.
Property InternalObject (p. 1254) Gets the internal object. For advanced
usage only.
Property LockPositionOfDependentEdgeSplits (p. 1254) Gets or sets the
LockPositionOfDependentEdgeSplits.
Property MaxEdgeLength (p. 1254) Gets or sets the MaxEdgeLength.
Property MaxFaceArea (p. 1254) Gets or sets the MaxFaceArea.
Property MaxSliverWidth (p. 1254) Gets or sets the MaxSliverWidth.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1250 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

Property MergeFaceEdges (p. 1255) Gets or sets the MergeFaceEdges.


Property Method (p. 1255) Gets or sets the Method.
Property MinEdgeLength (p. 1255) Gets or sets the MinEdgeLength.
Property MinFaceArea (p. 1255) Gets or sets the MinFaceArea.
Property MinSliverWidth (p. 1255) Gets or sets the MinSliverWidth.
Property RepairBehavior (p. 1255) Gets or sets the Behavior when Method
is set to "Repair".
Property SharedBoundaryRatio (p. 1256) Gets or sets the SharedBoundaryRatio.
Property SimplifyFaces (p. 1256) Gets or sets the SimplifyFaces.
Property VirtualEdges (p. 1256) Gets the VirtualEdges.
Property VirtualEntities (p. 1256) Gets the VirtualEntities.
Property VirtualFaces (p. 1256) Gets the VirtualFaces.
Property VirtualHardVertex (p. 1256) Gets the VirtualHardVertex.
Property VirtualSplitEdges (p. 1257) Gets the VirtualSplitEdges.
Property VirtualSplitFaces (p. 1257) Gets the VirtualSplitFaces.
Method AddComment() (p. 1257) Creates a new child Comment.
Method AddFigure() (p. 1257) Creates a new child Figure.
Method AddImage(string) (p. 1257) Creates a new child Image. If a filePath
is provided, the image will be loaded
from that file, if not, the image will be
a screen capture of the Geometry
window.
Method AddVirtualCell(ISelectionInfo) (p. 1258) Add Virtual Cell.
Method AddVirtualHardVertex(ISelectionInfo, Add Virtual Hard Vertex.
Point) (p. 1258)
Method AddVirtualSplitEdgeAt(ISelectionInfo, Add Virtual Split Edge at
Point) (p. 1258)
Method Delete() (p. 1259) Run the Delete action.
Method DeleteAllVirtualCells() (p. 1259) Delete all Virtual Cells.
Method DeleteAllVirtualEntities() (p. 1259) Delete all Virtual Entities.
Method DeleteAllVirtualHardVertices() (p. 1259) Delete all Virtual Split Hard Vertices.
Method DeleteAllVirtualSplitEdges() (p. 1259) Delete all Virtual Split Edges.
Method DeleteAllVirtualSplitFaces() (p. 1259) Delete all Virtual Split Faces.
Method GenerateVirtualCells(ISelectionInfo) (p. 1260) Generate the Virtual Cells on the
selected/all entities.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1260)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1260)
Method GetVirtualCellFromSelection(ISelectionInfo) (p. 1261)
Gets the Virtual Cell from the selection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1251
Ansys.ACT.Automation.Mechanical Namespace

Method VirtualSplitEdge(ISelectionInfo, double) (p. 1261) Generate the Virtual Cells on the
selected/all entities.
Method VirtualSplitFaceAtVertices(ISelectionInfo) (p. 1261) Generate the Virtual Cells on the
selected/all entities.

AspectRatio
Gets or sets the AspectRatio.

Declaration Syntax
public double AspectRatio { set;get; }

AutomaticBehavior
Gets or sets the Behavior when Method is set to "Automatic".

Declaration Syntax
public VirtualCellGroupAutomaticBehaviorType AutomaticBehavior { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

ContactAngle
Gets or sets the ContactAngle.

Declaration Syntax
public Quantity ContactAngle { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1252 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

CustomFeatureAngle
Gets or sets the CustomFeatureAngle.

Declaration Syntax
public Quantity CustomFeatureAngle { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EdgeAngle
Gets or sets the EdgeAngle.

Declaration Syntax
public Quantity EdgeAngle { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GaussAngle
Gets or sets the GaussAngle.

Declaration Syntax
public Quantity GaussAngle { set;get; }

GenerateOnUpdate
Gets or sets the GenerateOnUpdate.

Declaration Syntax
public YesNoType GenerateOnUpdate { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1253
Ansys.ACT.Automation.Mechanical Namespace

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSVirtualCellGroupAuto InternalObject { get; }

LockPositionOfDependentEdgeSplits
Gets or sets the LockPositionOfDependentEdgeSplits.

Declaration Syntax
public YesNoType LockPositionOfDependentEdgeSplits { set;get; }

MaxEdgeLength
Gets or sets the MaxEdgeLength.

Declaration Syntax
public Quantity MaxEdgeLength { set;get; }

MaxFaceArea
Gets or sets the MaxFaceArea.

Declaration Syntax
public Quantity MaxFaceArea { set;get; }

MaxSliverWidth
Gets or sets the MaxSliverWidth.

Declaration Syntax
public Quantity MaxSliverWidth { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1254 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

MergeFaceEdges
Gets or sets the MergeFaceEdges.

Declaration Syntax
public YesNoType MergeFaceEdges { set;get; }

Method
Gets or sets the Method.

Declaration Syntax
public VirtualCellGroupMethodType Method { set;get; }

MinEdgeLength
Gets or sets the MinEdgeLength.

Declaration Syntax
public Quantity MinEdgeLength { set;get; }

MinFaceArea
Gets or sets the MinFaceArea.

Declaration Syntax
public Quantity MinFaceArea { set;get; }

MinSliverWidth
Gets or sets the MinSliverWidth.

Declaration Syntax
public Quantity MinSliverWidth { set;get; }

RepairBehavior
Gets or sets the Behavior when Method is set to "Repair".

Declaration Syntax
public VirtualCellGroupRepairBehaviorType RepairBehavior { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1255
Ansys.ACT.Automation.Mechanical Namespace

SharedBoundaryRatio
Gets or sets the SharedBoundaryRatio.

Declaration Syntax
public double SharedBoundaryRatio { set;get; }

SimplifyFaces
Gets or sets the SimplifyFaces.

Declaration Syntax
public YesNoType SimplifyFaces { set;get; }

VirtualEdges
Gets the VirtualEdges.

Declaration Syntax
public int VirtualEdges { get; }

VirtualEntities
Gets the VirtualEntities.

Declaration Syntax
public int VirtualEntities { get; }

VirtualFaces
Gets the VirtualFaces.

Declaration Syntax
public int VirtualFaces { get; }

VirtualHardVertex
Gets the VirtualHardVertex.

Declaration Syntax
public int VirtualHardVertex { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1256 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

VirtualSplitEdges
Gets the VirtualSplitEdges.

Declaration Syntax
public int VirtualSplitEdges { get; }

VirtualSplitFaces
Gets the VirtualSplitFaces.

Declaration Syntax
public int VirtualSplitFaces { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1257
Ansys.ACT.Automation.Mechanical Namespace

AddVirtualCell(ISelectionInfo)
Add Virtual Cell.

Declaration Syntax
public virtual IEnumerable<VirtualCell> AddVirtualCell(ISelectionInfo iSelInfo)

Parameters
iSelInfo(ISelectionInfo)

No details are provided for this entry.

AddVirtualHardVertex(ISelectionInfo, Point)
Add Virtual Hard Vertex.

Declaration Syntax
public virtual void AddVirtualHardVertex(ISelectionInfo iSelInfo, Point point)

Parameters
iSelInfo(ISelectionInfo)

No details are provided for this entry.

point(Point)

No details are provided for this entry.

AddVirtualSplitEdgeAt(ISelectionInfo, Point)
Add Virtual Split Edge at

Declaration Syntax
public virtual void AddVirtualSplitEdgeAt(ISelectionInfo iSelInfo, Point point)

Parameters
iSelInfo(ISelectionInfo)

No details are provided for this entry.

point(Point)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1258 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DeleteAllVirtualCells()
Delete all Virtual Cells.

Declaration Syntax
public virtual void DeleteAllVirtualCells()

DeleteAllVirtualEntities()
Delete all Virtual Entities.

Declaration Syntax
public virtual void DeleteAllVirtualEntities()

DeleteAllVirtualHardVertices()
Delete all Virtual Split Hard Vertices.

Declaration Syntax
public virtual void DeleteAllVirtualHardVertices()

DeleteAllVirtualSplitEdges()
Delete all Virtual Split Edges.

Declaration Syntax
public virtual void DeleteAllVirtualSplitEdges()

DeleteAllVirtualSplitFaces()
Delete all Virtual Split Faces.

Declaration Syntax
public virtual void DeleteAllVirtualSplitFaces()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1259
Ansys.ACT.Automation.Mechanical Namespace

GenerateVirtualCells(ISelectionInfo)
Generate the Virtual Cells on the selected/all entities.

Declaration Syntax
public virtual void GenerateVirtualCells(ISelectionInfo selectionInfo)

Parameters
selectionInfo(ISelectionInfo)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1260 of ANSYS, Inc. and its subsidiaries and affiliates.
VirtualTopology

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetVirtualCellFromSelection(ISelectionInfo)
Gets the Virtual Cell from the selection.

Declaration Syntax
public virtual VirtualCell GetVirtualCellFromSelection(ISelectionInfo currentSelection)

Parameters
currentSelection(ISelectionInfo)

Selection used to find the associated Virtual Cell.

VirtualSplitEdge(ISelectionInfo, double)
Generate the Virtual Cells on the selected/all entities.

Declaration Syntax
public virtual void VirtualSplitEdge(ISelectionInfo iSelInfo, double splitRatio)

Parameters
iSelInfo(ISelectionInfo)

No details are provided for this entry.

splitRatio(double)

No details are provided for this entry.

VirtualSplitFaceAtVertices(ISelectionInfo)
Generate the Virtual Cells on the selected/all entities.

Declaration Syntax
public virtual void VirtualSplitFaceAtVertices(ISelectionInfo iSelInfo)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1261
Ansys.ACT.Automation.Mechanical Namespace

Parameters
iSelInfo(ISelectionInfo)

No details are provided for this entry.

VolumeConstraint
Defines a VolumeConstraint.

Declaration Syntax
public class VolumeConstraint : ResponseConstraint

Table 361: Members

Property Children (p. 988) Gets the list of children.

(Inherited from ResponseConstraint (p. 988).)


Property DataModelObjectCategory (p. 1262) Gets the current DataModelObject's category.
Property DefineBy (p. 1263) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 989) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 988).)


Property InternalObject (p. 1263) Gets the internal object. For advanced usage only.
Property Location (p. 1263) Gets or sets the Location.
Property MaximumAbsoluteValue (p. 1263) Gets or sets the MaximumAbsoluteValue.
Property MinimumAbsoluteValue (p. 1263) Gets or sets the MinimumAbsoluteValue.
Property PercentageToRetain (p. 1263) Gets or sets the PercentageToRetain.
Property PercentageToRetainMax (p. 1264) Gets or sets the PercentageToRetainMax.
Property PercentageToRetainMin (p. 1264) Gets or sets the PercentageToRetainMin.
Property ScopingMethod (p. 1264) Gets or sets the ScopingMethod.
Property Selection (p. 1264) Gets or sets the Selection.
Property Suppressed (p. 989) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 988).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1262 of ANSYS, Inc. and its subsidiaries and affiliates.
VolumeConstraint

DefineBy
Gets or sets the DefineBy.

Declaration Syntax
public ResponseConstraintDefineBy DefineBy { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

MaximumAbsoluteValue
Gets or sets the MaximumAbsoluteValue.

Declaration Syntax
public Quantity MaximumAbsoluteValue { set;get; }

MinimumAbsoluteValue
Gets or sets the MinimumAbsoluteValue.

Declaration Syntax
public Quantity MinimumAbsoluteValue { set;get; }

PercentageToRetain
Gets or sets the PercentageToRetain.

Declaration Syntax
public int PercentageToRetain { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1263
Ansys.ACT.Automation.Mechanical Namespace

PercentageToRetainMax
Gets or sets the PercentageToRetainMax.

Declaration Syntax
public int PercentageToRetainMax { set;get; }

PercentageToRetainMin
Gets or sets the PercentageToRetainMin.

Declaration Syntax
public int PercentageToRetainMin { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Selection
Gets or sets the Selection.

Declaration Syntax
public OptimizationRegion Selection { set;get; }

Worksheet
No details are provided for this entry.

Declaration Syntax
public abstract class Worksheet : IWorksheet

ZCrossSection
Defines a ZCrossSection.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1264 of ANSYS, Inc. and its subsidiaries and affiliates.
ZCrossSection

Declaration Syntax
public class ZCrossSection : CrossSection

Table 362: Members

Property Area (p. 1265) Gets the Area.


Property Children (p. 452) Gets the list of children.

(Inherited from CrossSection (p. 451).)


Property Comments (p. 452) Gets the list of associated comments.

(Inherited from CrossSection (p. 451).)


Property DataModelObjectCategory (p. 1265)Gets the current DataModelObject's
category.
Property Figures (p. 453) Gets the list of associated figures.

(Inherited from CrossSection (p. 451).)


Property Images (p. 453) Gets the list of associated images.

(Inherited from CrossSection (p. 451).)


Property InternalObject (p. 1266) Gets the internal object. For advanced usage
only.
Property IYY (p. 1266) Gets the IYY.
Property IZZ (p. 1266) Gets the IZZ.
Property Thick1 (p. 1266) Gets or sets the Thick1.
Property Thick2 (p. 1266) Gets or sets the Thick2.
Property Thick3 (p. 1266) Gets or sets the Thick3.
Property Width1 (p. 1267) Gets or sets the Width1.
Property Width2 (p. 1267) Gets or sets the Width2.
Property Width3 (p. 1267) Gets or sets the Width3.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1265
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCrossSectionAuto InternalObject { get; }

IYY
Gets the IYY.

Declaration Syntax
public Quantity IYY { get; }

IZZ
Gets the IZZ.

Declaration Syntax
public Quantity IZZ { get; }

Thick1
Gets or sets the Thick1.

Declaration Syntax
public Quantity Thick1 { set;get; }

Thick2
Gets or sets the Thick2.

Declaration Syntax
public Quantity Thick2 { set;get; }

Thick3
Gets or sets the Thick3.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1266 of ANSYS, Inc. and its subsidiaries and affiliates.
ZCrossSection

Declaration Syntax
public Quantity Thick3 { set;get; }

Width1
Gets or sets the Width1.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

Width3
Gets or sets the Width3.

Declaration Syntax
public Quantity Width3 { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1267
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1268 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.FE Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.FE

Table 363: Members

Command (p. 1269) Base class for all


Commands.
CommandColl (p. 1270) Collection of
commands.
CommandRepository (p. 1270) Command repository.
CommandsType (p. 1272) Commands type.
FEParser (p. 1273) FE parser object.

Command
Base class for all Commands.

Declaration Syntax
public class Command : ICommand

Table 364: Members

Property Index (p. 1269) Gets the command


index.
Property Name (p. 1269) Gets the command
name.

Index
Gets the command index.

Declaration Syntax
public uint Index { get; }

Name
Gets the command name.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1269
Ansys.ACT.Automation.Mechanical.FE Namespace

Declaration Syntax
public string Name { get; }

CommandColl
Collection of commands.

Declaration Syntax
public class CommandColl : IEnumerable<ICommand>, IEnumerable

Table 365: Members

Property Count (p. 1270) Gets the count of


commands.
Property Item (p. 1270) Accessor by zero-based
index.

Count
Gets the count of commands.

Declaration Syntax
public uint Count { get; }

Item(uint)
Accessor by zero-based index.

Declaration Syntax
public ICommand Item { get; }

CommandRepository
Command repository.

Declaration Syntax
public class CommandRepository

Table 366: Members

Method GetCommandByIndex(int) (p. 1271) Gets the commands by index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1270 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandRepository

Method GetCommandName(CommandsType, int) (p. 1271) Gets the name of commands of a type
specified by params eCommandsType
and index in the repository.
Method GetCommandNames(CommandsType) (p. 1272) Gets the command names of a type
specified by params eCommandsType
and index in the repository.
Method GetCommandNamesCount(CommandsType) (p. 1272)Gets the number of commands of a
type specified by
param=eCommandsType in the
repository.
Method GetCommandsByName(string) (p. 1272) Gets the commands by name.

GetCommandByIndex(int)
Gets the commands by index.

Declaration Syntax
public ICommand GetCommandByIndex(int index)

Parameters
index(int)

1 based index.

GetCommandName(CommandsType, int)
Gets the name of commands of a type specified by params eCommandsType and index in the repos-
itory.

Declaration Syntax
public string GetCommandName(CommandsType eCommandsType, int index)

Parameters
eCommandsType(CommandsType)

Command type. Valid options are: Ansys.ACT.Automation.Mechanical.FE.CommandsType.Processed


Ansys.ACT.Automation.Mechanical.FE.CommandsType.UnProcessed Ansys.ACT.Automation.Mech-
anical.FE.CommandsType.All

index(int)

1 based index

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1271
Ansys.ACT.Automation.Mechanical.FE Namespace

GetCommandNames(CommandsType)
Gets the command names of a type specified by params eCommandsType and index in the repository.

Declaration Syntax
public IReadOnlyList<string> GetCommandNames(CommandsType eCommandsType)

Parameters
eCommandsType(CommandsType)

Command type. Valid options are: Ansys.ACT.Automation.Mechanical.FE.CommandsType.Processed


Ansys.ACT.Automation.Mechanical.FE.CommandsType.UnProcessed Ansys.ACT.Automation.Mech-
anical.FE.CommandsType.All

GetCommandNamesCount(CommandsType)
Gets the number of commands of a type specified by param=eCommandsType in the repository.

Declaration Syntax
public int GetCommandNamesCount(CommandsType eCommandsType)

Parameters
eCommandsType(CommandsType)

Command type. Valid options are: Ansys.ACT.Automation.Mechanical.FE.CommandsType.Processed


Ansys.ACT.Automation.Mechanical.FE.CommandsType.UnProcessed Ansys.ACT.Automation.Mech-
anical.FE.CommandsType.All

GetCommandsByName(string)
Gets the commands by name.

Declaration Syntax
public CommandColl GetCommandsByName(string name)

Parameters
name(string)

Command name.

CommandsType
Commands type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1272 of ANSYS, Inc. and its subsidiaries and affiliates.
FEParser

Declaration Syntax
public enum CommandsType

Table 367: Members

Member All All commands.


Member Processed Unprocessed
commands.
Member UnProcessed Processed
commands.

FEParser
FE parser object.

Declaration Syntax
public class FEParser

Table 368: Members

Constructor FEParser() (p. 1273) Default


constructor.

FEParser()
Default constructor.

Declaration Syntax
public FEParser()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1273
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1274 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.FE.NASTRAN
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.FE.NASTRAN

Table 369: Members

CaseControlCommand (p. 1275) Case control


command.
GenericCommand (p. 1276) Generic command.
NastranOption (p. 1276) Option.
NastranOptionLine (p. 1276) Option line.
OptionsControlCommand (p. 1277) Options control
command.

CaseControlCommand
Case control command.

Declaration Syntax
public class CaseControlCommand : NASTRANCommand

Table 370: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Text (p. 1275) Gets the text.

Text
Gets the text.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1275
Ansys.ACT.Automation.Mechanical.FE.NASTRAN Namespace

Declaration Syntax
public string Text { get; }

GenericCommand
Generic command.

Declaration Syntax
public class GenericCommand : NASTRANCommand

Table 371: Members

Property Arguments (p. 1276) Gets the arguments.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)

Arguments
Gets the arguments.

Declaration Syntax
public IReadOnlyList<object> Arguments { get; }

NastranOption
Option.

Declaration Syntax
public class NastranOption

NastranOptionLine
Option line.

Declaration Syntax
public class NastranOptionLine

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1276 of ANSYS, Inc. and its subsidiaries and affiliates.
OptionsControlCommand

OptionsControlCommand
Options control command.

Declaration Syntax
public class OptionsControlCommand : NASTRANCommand

Table 372: Members

Property Arguments (p. 1277) Gets the arguments.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property OptionLines (p. 1277) Gets the option lines.

Arguments
Gets the arguments.

Declaration Syntax
public IReadOnlyList<object> Arguments { get; }

OptionLines
Gets the option lines.

Declaration Syntax
public IReadOnlyList<object> OptionLines { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1277
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1278 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.FE.CDB
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.FE.CDB

Table 373: Members

BeamSecBlockCommand (p. 1280) Represents a beam SECBLOCK command.


BFBlockCommand (p. 1281) Represents a BFBLOCK command.
BFCommand (p. 1282) Represents a BF command.
BFEBlockCommand (p. 1284) Represents a BFEBLOCK command.
BFECommand (p. 1285) Represents a BFE command.
CECMODCommand (p. 1286) Represents a CECMOD command.
CECommand (p. 1287) Represents a CE command.
CMBlockCommand (p. 1288) Represents a CMBLOCK command.
CMEDITCommand (p. 1289) Represents a CMEDIT command.
CMGRPCommand (p. 1290) Represents a CMGRP command.
CommandCell (p. 1290) Represents cell data associated to a beam SECBLOCK
command.
CommandCETerm (p. 1291) Represents a term associated to a CE command.
CommandElement (p. 1292) Represents an element associated to an EBLOCK
command.
CommandElementBodyForce (p. 1294) Represents element body-force loads associated to
BFEBLOCK command.
CommandElementSurfaceLoad (p. 1295) Represents an element surface load associated to a
SFEBLOCK command.
CommandElementSurfaceLoadValues (p. 1296) Values associated to an element surface load from a
SFEBLOCK command.
CommandElementType (p. 1297) Represents an element type associated to an ETBLOCK
command.
CommandKeyOpt (p. 1298) Represents a KEYOPT command.
CommandLayer (p. 1298) Represents a layer associated to a shell SECBLOCK
command.
CommandNodalBodyForce (p. 1299) Represents a nodal body force associated to a
BFBLOCK command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1279
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

CommandNodalLoad (p. 1300) Represents an nodal load associated to an F BLOCK


or D Block command.
CommandNode (p. 1301) Represents a node associated to a NBLOCK command.
CommandReal (p. 1302) Represent a real constant set associated to a RLBLOCK
command.
CPCommand (p. 1303) Represents a CP command.
DBlockCommand (p. 1304) Represents a DBlock command.
EBlockCommand (p. 1304) Represents an EBLOCK command.
ENCommand (p. 1305) Represents an EN command.
ETBlockCommand (p. 1306) Represents a ETBLOCK command.
ETCommand (p. 1307) Represents an ET command.
FBlockCommand (p. 1308) Represents a FBlock command.
GenericCommand (p. 1308) Represents a generic command.
LocalCommand (p. 1309) Represents a LOCAL command.
MPCommand (p. 1310) Represents a MP command.
MPDataCommand (p. 1312) Represents a MPDATA command.
NBlockCommand (p. 1313) Represents a NBLOCK command.
NCommand (p. 1314) Represents a N command.
PreadCommand (p. 1315) Represents a *PREAD command.
RCommand (p. 1316) Represents a R command.
RLBlockCommand (p. 1317) Represents a RLBLOCK command.
SeccontrolCommand (p. 1317) Represents a SECCONTROL command.
SecdataCommand (p. 1318) Represents a SECDATA command.
SecoffsetCommand (p. 1318) Represents a SECOFFSET command.
SectypeCommand (p. 1319) Represents a SECTYPE command.
SFEBlockCommand (p. 1320) Represents a SFEBLOCK command.
SFECommand (p. 1321) Represents a SFE command.
ShellSecBlockCommand (p. 1323) Represents a shell SECBLOCK command.
TBDataCommand (p. 1324) Represents a TBDATA command.
TBDataValues (p. 1325) Represents data for a given temperature.
TBPTCommand (p. 1326) Represents a TBPT command.
TBPTData (p. 1328) Represents data for the TBPT command.
TBPTValues (p. 1329) Represents a tuple of values for the TBPT commmand.

BeamSecBlockCommand
Represents a beam SECBLOCK command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1280 of ANSYS, Inc. and its subsidiaries and affiliates.
BFBlockCommand

Declaration Syntax
public class BeamSecBlockCommand : CDBCommand

Table 374: Members

Property Cells (p. 1281) Gets the cells of the section.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Nodes (p. 1281) Gets the nodes of the
section.
Property Type (p. 1281) Gets the section type.

Cells
Gets the cells of the section.

Declaration Syntax
public IReadOnlyList<CommandCell> Cells { get; }

Nodes
Gets the nodes of the section.

Declaration Syntax
public IReadOnlyList<CommandNode> Nodes { get; }

Type
Gets the section type.

Declaration Syntax
public string Type { get; }

BFBlockCommand
Represents a BFBLOCK command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1281
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public class BFBlockCommand : CDBCommand

Table 375: Members

Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Lab (p. 1282) Gets the label.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property NodalBodyForceCount (p. 1282) Gets the number of nodal body-force
loads.
Property NodalBodyForces (p. 1282) Gets the nodal body-force loads.

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

NodalBodyForceCount
Gets the number of nodal body-force loads.

Declaration Syntax
public int NodalBodyForceCount { get; }

NodalBodyForces
Gets the nodal body-force loads.

Declaration Syntax
public IReadOnlyList<CommandNodalBodyForce> NodalBodyForces { get; }

BFCommand
Represents a BF command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1282 of ANSYS, Inc. and its subsidiaries and affiliates.
BFCommand

Declaration Syntax
public class BFCommand : CDBCommand

Table 376: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Lab (p. 1283) Gets the label.
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Node (p. 1283) Gets the node number.
Property ValCount (p. 1283) Gets the number of values.
Property Values (p. 1283) Gets the values.

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

Node
Gets the node number.

Declaration Syntax
public int Node { get; }

ValCount
Gets the number of values.

Declaration Syntax
public object ValCount { get; }

Values
Gets the values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1283
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public IReadOnlyList<object> Values { get; }

BFEBlockCommand
Represents a BFEBLOCK command.

Declaration Syntax
public class BFEBlockCommand : CDBCommand

Table 377: Members

Property ElementBodyForceCount (p. 1284) Gets the number of element body-force


loads.
Property ElementBodyForces (p. 1284) Gets the element body-force loads.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Lab (p. 1284) Gets the label.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)

ElementBodyForceCount
Gets the number of element body-force loads.

Declaration Syntax
public int ElementBodyForceCount { get; }

ElementBodyForces
Gets the element body-force loads.

Declaration Syntax
public IReadOnlyList<CommandElementBodyForce> ElementBodyForces { get; }

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1284 of ANSYS, Inc. and its subsidiaries and affiliates.
BFECommand

BFECommand
Represents a BFE command.

Declaration Syntax
public class BFECommand : CDBCommand

Table 378: Members

Property Elem (p. 1285) Gets the element number.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Lab (p. 1285) Gets the label.
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Stloc (p. 1285) Gets the starting location.
Property ValCount (p. 1286) Gets the number of values.
Property Values (p. 1286) Gets the values.

Elem
Gets the element number.

Declaration Syntax
public int Elem { get; }

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

Stloc
Gets the starting location.

Declaration Syntax
public int Stloc { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1285
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

ValCount
Gets the number of values.

Declaration Syntax
public object ValCount { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

CECMODCommand
Represents a CECMOD command.

Declaration Syntax
public class CECMODCommand : CDBCommand

Table 379: Members

Property Constant (p. 1286) Gets the constant term of the


equation.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Nce (p. 1286) Gets the constraint equation
number.

Constant
Gets the constant term of the equation.

Declaration Syntax
public double Constant { get; }

Nce
Gets the constraint equation number.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1286 of ANSYS, Inc. and its subsidiaries and affiliates.
CECommand

Declaration Syntax
public uint Nce { get; }

CECommand
Represents a CE command.

Declaration Syntax
public class CECommand : CDBCommand

Table 380: Members

Property Constant (p. 1287) Gets the constant term of the


equation.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Nce (p. 1287) Gets the constraint equation
number.
Property Terms (p. 1287) Gets the equation terms.

Constant
Gets the constant term of the equation.

Declaration Syntax
public double Constant { get; }

Nce
Gets the constraint equation number.

Declaration Syntax
public uint Nce { get; }

Terms
Gets the equation terms.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1287
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public IReadOnlyList<CommandCETerm> Terms { get; }

CMBlockCommand
Represents a CMBLOCK command.

Declaration Syntax
public class CMBlockCommand : CDBCommand

Table 381: Members

Property Cmname (p. 1288) Gets the component name.


Property Elements (p. 1288) Gets the type of entities.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Type (p. 1288) Gets the type of entities (node or
elem).

Cmname
Gets the component name.

Declaration Syntax
public string Cmname { get; }

Elements
Gets the type of entities.

Declaration Syntax
public IReadOnlyList<int> Elements { get; }

Type
Gets the type of entities (node or elem).

Declaration Syntax
public string Type { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1288 of ANSYS, Inc. and its subsidiaries and affiliates.
CMEDITCommand

CMEDITCommand
Represents a CMEDIT command.

Declaration Syntax
public class CMEDITCommand : CDBCommand

Table 382: Members

Property Aname (p. 1289) Gets the assembly name.


Property Cnames (p. 1289) Gets the component names.
Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Oper (p. 1289) Gets the operation label (add or
dele).

Aname
Gets the assembly name.

Declaration Syntax
public string Aname { get; }

Cnames
Gets the component names.

Declaration Syntax
public IReadOnlyList<string> Cnames { get; }

Oper
Gets the operation label (add or dele).

Declaration Syntax
public string Oper { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1289
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

CMGRPCommand
Represents a CMGRP command.

Declaration Syntax
public class CMGRPCommand : CDBCommand

Table 383: Members

Property Aname (p. 1290) Gets the assembly name.


Property Cnames (p. 1290) Gets the component and/or assembly
names.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)

Aname
Gets the assembly name.

Declaration Syntax
public string Aname { get; }

Cnames
Gets the component and/or assembly names.

Declaration Syntax
public IReadOnlyList<string> Cnames { get; }

CommandCell
Represents cell data associated to a beam SECBLOCK command.

Declaration Syntax
public class CommandCell

Table 384: Members

Property MatId (p. 1291) Gets the material


number.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1290 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandCETerm

Property Nodes (p. 1291) Gets the nodes.

MatId
Gets the material number.

Declaration Syntax
public uint MatId { get; }

Nodes
Gets the nodes.

Declaration Syntax
public IReadOnlyList<uint> Nodes { get; }

CommandCETerm
Represents a term associated to a CE command.

Declaration Syntax
public class CommandCETerm

Table 385: Members

Property Coefficient (p. 1291) Gets the coefficient.


Property Dof (p. 1291) Gets the degree of
freedom.
Property Node (p. 1292) Gets the node number.

Coefficient
Gets the coefficient.

Declaration Syntax
public double Coefficient { get; }

Dof
Gets the degree of freedom.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1291
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public string Dof { get; }

Node
Gets the node number.

Declaration Syntax
public uint Node { get; }

CommandElement
Represents an element associated to an EBLOCK command.

Declaration Syntax
public class CommandElement

Table 386: Members

Property Csys (p. 1292) Gets the coordinate system number.


Property ElementShapeFlag (p. 1292) Gets the element shape flag used for contact element
types.
Property Id (p. 1293) Gets the element number.
Property Mat (p. 1293) Gets the material number.
Property NodeCount (p. 1293) Gets the number of nodes.
Property Nodes (p. 1293) Gets the nodes.
Property Real (p. 1293) Gets the real constant set number.
Property Section (p. 1293) Gets the section number.
Property Type (p. 1294) Gets the element type number.

Csys
Gets the coordinate system number.

Declaration Syntax
public uint Csys { get; }

ElementShapeFlag
Gets the element shape flag used for contact element types.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1292 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandElement

Declaration Syntax
public int ElementShapeFlag { get; }

Id
Gets the element number.

Declaration Syntax
public uint Id { get; }

Mat
Gets the material number.

Declaration Syntax
public uint Mat { get; }

NodeCount
Gets the number of nodes.

Declaration Syntax
public int NodeCount { get; }

Nodes
Gets the nodes.

Declaration Syntax
public IReadOnlyList<int> Nodes { get; }

Real
Gets the real constant set number.

Declaration Syntax
public uint Real { get; }

Section
Gets the section number.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1293
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public uint Section { get; }

Type
Gets the element type number.

Declaration Syntax
public uint Type { get; }

CommandElementBodyForce
Represents element body-force loads associated to BFEBLOCK command.

Declaration Syntax
public class CommandElementBodyForce

Table 387: Members

Property Count (p. 1294) Gets the number of element body-force


loads.
Property Elem (p. 1294) Gets the element number.
Property Stlocs (p. 1294) Gets the starting locations.
Property Values (p. 1295) Gets the values.

Count
Gets the number of element body-force loads.

Declaration Syntax
public int Count { get; }

Elem
Gets the element number.

Declaration Syntax
public int Elem { get; }

Stlocs
Gets the starting locations.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1294 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandElementSurfaceLoad

Declaration Syntax
public IReadOnlyList<int> Stlocs { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

CommandElementSurfaceLoad
Represents an element surface load associated to a SFEBLOCK command.

Declaration Syntax
public class CommandElementSurfaceLoad

Table 388: Members

Property Count (p. 1295) Gets the number of element surface


loads.
Property Elem (p. 1295) Gets the element number.
Property ElementSurfaceLoadValues (p. 1296) Gets the values.
Property Keys (p. 1296) Gets the keys.
Property LKeys (p. 1296) Gets the load keys.

Count
Gets the number of element surface loads.

Declaration Syntax
public int Count { get; }

Elem
Gets the element number.

Declaration Syntax
public int Elem { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1295
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

ElementSurfaceLoadValues
Gets the values.

Declaration Syntax
public IReadOnlyList<CommandElementSurfaceLoadValues> ElementSurfaceLoadValues { get; }

Keys
Gets the keys.

Declaration Syntax
public IReadOnlyList<int> Keys { get; }

LKeys
Gets the load keys.

Declaration Syntax
public IReadOnlyList<int> LKeys { get; }

CommandElementSurfaceLoadValues
Values associated to an element surface load from a SFEBLOCK command.

Declaration Syntax
public class CommandElementSurfaceLoadValues

Table 389: Members

Property ValueCount (p. 1296) Gets the number of


values.
Property Values (p. 1297) Gets the values.

ValueCount
Gets the number of values.

Declaration Syntax
public int ValueCount { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1296 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandElementType

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

CommandElementType
Represents an element type associated to an ETBLOCK command.

Declaration Syntax
public class CommandElementType

Table 390: Members

Property Ename (p. 1297) Gets the element


name.
Property Id (p. 1297) Gets the element
number.
Property Keyopts (p. 1297) Gets the key options.

Ename
Gets the element name.

Declaration Syntax
public uint Ename { get; }

Id
Gets the element number.

Declaration Syntax
public uint Id { get; }

Keyopts
Gets the key options.

Declaration Syntax
public IReadOnlyList<CommandKeyOpt> Keyopts { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1297
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

CommandKeyOpt
Represents a KEYOPT command.

Declaration Syntax
public class CommandKeyOpt

Table 391: Members

Property Knum (p. 1298) Gets the key option


number.
Property Value (p. 1298) Gets the value.

Knum
Gets the key option number.

Declaration Syntax
public uint Knum { get; }

Value
Gets the value.

Declaration Syntax
public int Value { get; }

CommandLayer
Represents a layer associated to a shell SECBLOCK command.

Declaration Syntax
public class CommandLayer

Table 392: Members

Property Mat (p. 1299) Gets the material number.


Property Numpt (p. 1299) Gets the number of integration points in the
layer.
Property Theta (p. 1299) Gets the layer orientation angle.
Property Thick (p. 1299) Gets the thickness.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1298 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandNodalBodyForce

Mat
Gets the material number.

Declaration Syntax
public uint Mat { get; }

Numpt
Gets the number of integration points in the layer.

Declaration Syntax
public uint Numpt { get; }

Theta
Gets the layer orientation angle.

Declaration Syntax
public double Theta { get; }

Thick
Gets the thickness.

Declaration Syntax
public double Thick { get; }

CommandNodalBodyForce
Represents a nodal body force associated to a BFBLOCK command.

Declaration Syntax
public class CommandNodalBodyForce

Table 393: Members

Property Node (p. 1300) Gets the node


number.
Property ValCount (p. 1300) Gets the number of
values.
Property Values (p. 1300) Gets the values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1299
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Node
Gets the node number.

Declaration Syntax
public int Node { get; }

ValCount
Gets the number of values.

Declaration Syntax
public int ValCount { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

CommandNodalLoad
Represents an nodal load associated to an F BLOCK or D Block command.

Declaration Syntax
public class CommandNodalLoad

Table 394: Members

Property Dof (p. 1300) Gets the dof.


Property Node (p. 1301) Gets the node
number.
Property ValueCount (p. 1301) Gets the number of
values.
Property Values (p. 1301) Gets the values.

Dof
Gets the dof.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1300 of ANSYS, Inc. and its subsidiaries and affiliates.
CommandNode

Declaration Syntax
public string Dof { get; }

Node
Gets the node number.

Declaration Syntax
public int Node { get; }

ValueCount
Gets the number of values.

Declaration Syntax
public int ValueCount { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

CommandNode
Represents a node associated to a NBLOCK command.

Declaration Syntax
public class CommandNode

Table 395: Members

Property Id (p. 1301) Gets the node


number.
Property Location (p. 1302) Gets the
coordinates.
Property Rotation (p. 1302) Gets the rotation
angles.

Id
Gets the node number.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1301
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public uint Id { get; }

Location
Gets the coordinates.

Declaration Syntax
public IReadOnlyList<double> Location { get; }

Rotation
Gets the rotation angles.

Declaration Syntax
public IReadOnlyList<double> Rotation { get; }

CommandReal
Represent a real constant set associated to a RLBLOCK command.

Declaration Syntax
public class CommandReal

Table 396: Members

Property Id (p. 1302) Gets the real constant set


number.
Property Values (p. 1302) Gets the values.

Id
Gets the real constant set number.

Declaration Syntax
public uint Id { get; }

Values
Gets the values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1302 of ANSYS, Inc. and its subsidiaries and affiliates.
CPCommand

Declaration Syntax
public IReadOnlyList<double> Values { get; }

CPCommand
Represents a CP command.

Declaration Syntax
public class CPCommand : CDBCommand

Table 397: Members

Property Dof (p. 1303) Gets the degree of freedom


label.
Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Ncp (p. 1303) Gets the number of coupled
nodes.
Property Nodes (p. 1303) Gets the nodes.

Dof
Gets the degree of freedom label.

Declaration Syntax
public string Dof { get; }

Ncp
Gets the number of coupled nodes.

Declaration Syntax
public uint Ncp { get; }

Nodes
Gets the nodes.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1303
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public IReadOnlyList<int> Nodes { get; }

DBlockCommand
Represents a DBlock command.

Declaration Syntax
public class DBlockCommand : CDBCommand

Table 398: Members

Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property NodalLoads (p. 1304) Get the element surface loads.
Property NodalLoadsCount (p. 1304) Gets the number of element surface
loads.

NodalLoads
Get the element surface loads.

Declaration Syntax
public IReadOnlyList<CommandNodalLoad> NodalLoads { get; }

NodalLoadsCount
Gets the number of element surface loads.

Declaration Syntax
public int NodalLoadsCount { get; }

EBlockCommand
Represents an EBLOCK command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1304 of ANSYS, Inc. and its subsidiaries and affiliates.
ENCommand

Declaration Syntax
public class EBlockCommand : CDBCommand

Table 399: Members

Property Elements (p. 1305) Gets the elements.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)

Elements
Gets the elements.

Declaration Syntax
public IReadOnlyList<CommandElement> Elements { get; }

ENCommand
Represents an EN command.

Declaration Syntax
public class ENCommand : CDBCommand

Table 400: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Type (p. 1305) Gets the type (attribute or
node).
Property Values (p. 1306) Gets the values.

Type
Gets the type (attribute or node).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1305
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public string Type { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<int> Values { get; }

ETBlockCommand
Represents a ETBLOCK command.

Declaration Syntax
public class ETBlockCommand : CDBCommand

Table 401: Members

Property ElementTypeCount (p. 1306) Gets the element type


count.
Property ElementTypes (p. 1306) Gets the element types.
Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)

ElementTypeCount
Gets the element type count.

Declaration Syntax
public int ElementTypeCount { get; }

ElementTypes
Gets the element types.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1306 of ANSYS, Inc. and its subsidiaries and affiliates.
ETCommand

Declaration Syntax
public IReadOnlyList<CommandElementType> ElementTypes { get; }

ETCommand
Represents an ET command.

Declaration Syntax
public class ETCommand : CDBCommand

Table 402: Members

Property Ename (p. 1307) Gets the element name.


Property Id (p. 1307) Gets the element number.
Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Keyopts (p. 1307) Gets the key options.
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)

Ename
Gets the element name.

Declaration Syntax
public uint Ename { get; }

Id
Gets the element number.

Declaration Syntax
public uint Id { get; }

Keyopts
Gets the key options.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1307
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public IReadOnlyList<CommandKeyOpt> Keyopts { get; }

FBlockCommand
Represents a FBlock command.

Declaration Syntax
public class FBlockCommand : CDBCommand

Table 403: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property NodalLoads (p. 1308) Gets the element types.
Property NodalLoadsCount (p. 1308) Gets the element type
count.

NodalLoads
Gets the element types.

Declaration Syntax
public IReadOnlyList<CommandNodalLoad> NodalLoads { get; }

NodalLoadsCount
Gets the element type count.

Declaration Syntax
public int NodalLoadsCount { get; }

GenericCommand
Represents a generic command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1308 of ANSYS, Inc. and its subsidiaries and affiliates.
LocalCommand

Declaration Syntax
public class GenericCommand : CDBCommand

Table 404: Members

Property Arguments (p. 1309) Gets the arguments.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)

Arguments
Gets the arguments.

Declaration Syntax
public IReadOnlyList<string> Arguments { get; }

LocalCommand
Represents a LOCAL command.

Declaration Syntax
public class LocalCommand : CDBCommand

Table 405: Members

Property Cstyp (p. 1310) Gets the system type.


Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Ncsy (p. 1310) Gets the system number.
Property Type (p. 1310) Gets the type of the data to be
defined.
Property Values (p. 1310) Gets the values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1309
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Cstyp
Gets the system type.

Declaration Syntax
public uint Cstyp { get; }

Ncsy
Gets the system number.

Declaration Syntax
public uint Ncsy { get; }

Type
Gets the type of the data to be defined.

Declaration Syntax
public string Type { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

MPCommand
Represents a MP command.

Declaration Syntax
public class MPCommand : CDBCommand

Table 406: Members

Property C0 (p. 1311) Gets the temperature-independent term of the property.


Property C1 (p. 1311) Gets the coefficient of the linear term in the property-versus-temperature
polynomial.
Property C2 (p. 1311) Gets the coefficient of the quadratic term in the property-versus-temperature
polynomial.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1310 of ANSYS, Inc. and its subsidiaries and affiliates.
MPCommand

Property C3 (p. 1311) Gets the coefficient of the cubic term in the property-versus-temperature
polynomial.
Property C4 (p. 1312) Gets the coefficient of the quartic term in the property-versus-temperature
polynomial.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Lab (p. 1312) Gets the label.
Property Mat (p. 1312) Gets the material number.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)

C0
Gets the temperature-independent term of the property.

Declaration Syntax
public double C0 { get; }

C1
Gets the coefficient of the linear term in the property-versus-temperature polynomial.

Declaration Syntax
public double C1 { get; }

C2
Gets the coefficient of the quadratic term in the property-versus-temperature polynomial.

Declaration Syntax
public double C2 { get; }

C3
Gets the coefficient of the cubic term in the property-versus-temperature polynomial.

Declaration Syntax
public double C3 { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1311
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

C4
Gets the coefficient of the quartic term in the property-versus-temperature polynomial.

Declaration Syntax
public double C4 { get; }

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

Mat
Gets the material number.

Declaration Syntax
public uint Mat { get; }

MPDataCommand
Represents a MPDATA command.

Declaration Syntax
public class MPDataCommand : CDBCommand

Table 407: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Lab (p. 1313) Gets the label.
Property Mat (p. 1313) Gets the material number.
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Temps (p. 1313) Gets the temperatures.
Property Values (p. 1313) Gets the values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1312 of ANSYS, Inc. and its subsidiaries and affiliates.
NBlockCommand

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

Mat
Gets the material number.

Declaration Syntax
public uint Mat { get; }

Temps
Gets the temperatures.

Declaration Syntax
public IReadOnlyList<double> Temps { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

NBlockCommand
Represents a NBLOCK command.

Declaration Syntax
public class NBlockCommand : CDBCommand

Table 408: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1313
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

(Inherited from
Command (p. 1269).)
Property Nodes (p. 1314) Gets the nodes.

Nodes
Gets the nodes.

Declaration Syntax
public IReadOnlyList<CommandNode> Nodes { get; }

NCommand
Represents a N command.

Declaration Syntax
public class NCommand : CDBCommand

Table 409: Members

Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Node (p. 1314) Gets the node number.
Property Type (p. 1314) Gets the type of the data to be
defined.
Property Values (p. 1315) Gets the values.

Node
Gets the node number.

Declaration Syntax
public uint Node { get; }

Type
Gets the type of the data to be defined.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1314 of ANSYS, Inc. and its subsidiaries and affiliates.
PreadCommand

Declaration Syntax
public string Type { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

PreadCommand
Represents a *PREAD command.

Declaration Syntax
public class PreadCommand : CDBCommand

Table 410: Members

Property Aname (p. 1315) Gets the table name.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Values (p. 1315) Gets the values.

Aname
Gets the table name.

Declaration Syntax
public string Aname { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1315
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

RCommand
Represents a R command.

Declaration Syntax
public class RCommand : CDBCommand

Table 411: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Nset (p. 1316) Gets the set number.
Property Stloc (p. 1316) Gets the starting location.
Property Values (p. 1316) Gets the values.

Nset
Gets the set number.

Declaration Syntax
public uint Nset { get; }

Stloc
Gets the starting location.

Declaration Syntax
public uint Stloc { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1316 of ANSYS, Inc. and its subsidiaries and affiliates.
SeccontrolCommand

RLBlockCommand
Represents a RLBLOCK command.

Declaration Syntax
public class RLBlockCommand : CDBCommand

Table 412: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Reals (p. 1317) Gets the real constant sets.

Reals
Gets the real constant sets.

Declaration Syntax
public IReadOnlyList<CommandReal> Reals { get; }

SeccontrolCommand
Represents a SECCONTROL command.

Declaration Syntax
public class SeccontrolCommand : CDBCommand

Table 413: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Values (p. 1318) Gets the values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1317
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

SecdataCommand
Represents a SECDATA command.

Declaration Syntax
public class SecdataCommand : CDBCommand

Table 414: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Values (p. 1318) Gets the values.

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

SecoffsetCommand
Represents a SECOFFSET command.

Declaration Syntax
public class SecoffsetCommand : CDBCommand

Table 415: Members

Property Index (p. 1269) Gets the command index.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1318 of ANSYS, Inc. and its subsidiaries and affiliates.
SectypeCommand

(Inherited from Command (p. 1269).)


Property Location (p. 1319) Gets the location of nodes in the
section.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Values (p. 1319) Gets the values.

Location
Gets the location of nodes in the section.

Declaration Syntax
public string Location { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

SectypeCommand
Represents a SECTYPE command.

Declaration Syntax
public class SectypeCommand : CDBCommand

Table 416: Members

Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property RefineKey (p. 1320) Mesh refinement level for thin-walled beam sections. Default is zero.
Meaningless if type is not BEAM.
Property Secid (p. 1320) Gets the section type number.
Property Secname (p. 1320) Gets the section name.
Property Subtype (p. 1320) Gets the subtype.
Property Type (p. 1320) Get the type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1319
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

RefineKey
Mesh refinement level for thin-walled beam sections. Default is zero. Meaningless if type is not BEAM.

Declaration Syntax
public int RefineKey { get; }

Secid
Gets the section type number.

Declaration Syntax
public uint Secid { get; }

Secname
Gets the section name.

Declaration Syntax
public string Secname { get; }

Subtype
Gets the subtype.

Declaration Syntax
public string Subtype { get; }

Type
Get the type.

Declaration Syntax
public string Type { get; }

SFEBlockCommand
Represents a SFEBLOCK command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1320 of ANSYS, Inc. and its subsidiaries and affiliates.
SFECommand

Declaration Syntax
public class SFEBlockCommand : CDBCommand

Table 417: Members

Property ElementSurfaceLoadCount (p. 1321)Gets the number of element surface


loads.
Property ElementSurfaceLoads (p. 1321) Get the element surface loads.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Lab (p. 1321) Gets the surface load label.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)

ElementSurfaceLoadCount
Gets the number of element surface loads.

Declaration Syntax
public int ElementSurfaceLoadCount { get; }

ElementSurfaceLoads
Get the element surface loads.

Declaration Syntax
public IReadOnlyList<CommandElementSurfaceLoad> ElementSurfaceLoads { get; }

Lab
Gets the surface load label.

Declaration Syntax
public string Lab { get; }

SFECommand
Represents a SFE command.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1321
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public class SFECommand : CDBCommand

Table 418: Members

Property Elem (p. 1322) Gets the element number.


Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Key (p. 1322) Gets the value key.
Property Lab (p. 1322) Gets the load label.
Property LKey (p. 1322) Get the load key.
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Values (p. 1323) Gets the values.

Elem
Gets the element number.

Declaration Syntax
public uint Elem { get; }

Key
Gets the value key.

Declaration Syntax
public uint Key { get; }

Lab
Gets the load label.

Declaration Syntax
public string Lab { get; }

LKey
Get the load key.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1322 of ANSYS, Inc. and its subsidiaries and affiliates.
ShellSecBlockCommand

Declaration Syntax
public uint LKey { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

ShellSecBlockCommand
Represents a shell SECBLOCK command.

Declaration Syntax
public class ShellSecBlockCommand : CDBCommand

Table 419: Members

Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Layers (p. 1323) Gets the layers.
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)
Property Type (p. 1323) Get the section type.

Layers
Gets the layers.

Declaration Syntax
public IReadOnlyList<CommandLayer> Layers { get; }

Type
Get the section type.

Declaration Syntax
public string Type { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1323
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

TBDataCommand
Represents a TBDATA command.

Declaration Syntax
public class TBDataCommand : CDBCommand

Table 420: Members

Property DataValueCount (p. 1324) Gets the number of data values.


Property DataValues (p. 1324) Gets the data values.
Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Lab (p. 1324) Gets the label.
Property Mat (p. 1325) Gets the material number.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Npts (p. 1325) Gets the number of points, if provided.
Property Ntemp (p. 1325) Gets the number of temperature, if
provided.
Property Tbopt (p. 1325) Gets the option.

DataValueCount
Gets the number of data values.

Declaration Syntax
public int DataValueCount { get; }

DataValues
Gets the data values.

Declaration Syntax
public IReadOnlyList<TBDataValues> DataValues { get; }

Lab
Gets the label.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1324 of ANSYS, Inc. and its subsidiaries and affiliates.
TBDataValues

Declaration Syntax
public string Lab { get; }

Mat
Gets the material number.

Declaration Syntax
public int Mat { get; }

Npts
Gets the number of points, if provided.

Declaration Syntax
public int Npts { get; }

Ntemp
Gets the number of temperature, if provided.

Declaration Syntax
public int Ntemp { get; }

Tbopt
Gets the option.

Declaration Syntax
public string Tbopt { get; }

TBDataValues
Represents data for a given temperature.

Declaration Syntax
public class TBDataValues

Table 421: Members

Property Temp (p. 1326) Gets the temperature.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1325
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Property ValueCount (p. 1326) Gets the number of


values.
Property Values (p. 1326) Gets the values.

Temp
Gets the temperature.

Declaration Syntax
public double Temp { get; }

ValueCount
Gets the number of values.

Declaration Syntax
public int ValueCount { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

TBPTCommand
Represents a TBPT command.

Declaration Syntax
public class TBPTCommand : CDBCommand

Table 422: Members

Property Index (p. 1269) Gets the command index.

(Inherited from Command (p. 1269).)


Property Lab (p. 1327) Gets the label.
Property Mat (p. 1327) Gets the material number.
Property Name (p. 1269) Gets the command name.

(Inherited from Command (p. 1269).)


Property Npts (p. 1327) Gets the number of points, if provided.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1326 of ANSYS, Inc. and its subsidiaries and affiliates.
TBPTCommand

Property Ntemp (p. 1327) Gets the number of temperature, if


provided.
Property Tbopt (p. 1327) Gets the option.
Property TBPTData (p. 1328) Gets TBPT data items.
Property TBPTDataCount (p. 1328) Gets the number of TBPT data.

Lab
Gets the label.

Declaration Syntax
public string Lab { get; }

Mat
Gets the material number.

Declaration Syntax
public int Mat { get; }

Npts
Gets the number of points, if provided.

Declaration Syntax
public int Npts { get; }

Ntemp
Gets the number of temperature, if provided.

Declaration Syntax
public int Ntemp { get; }

Tbopt
Gets the option.

Declaration Syntax
public string Tbopt { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1327
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

TBPTData
Gets TBPT data items.

Declaration Syntax
public IReadOnlyList<TBPTData> TBPTData { get; }

TBPTDataCount
Gets the number of TBPT data.

Declaration Syntax
public int TBPTDataCount { get; }

TBPTData
Represents data for the TBPT command.

Declaration Syntax
public class TBPTData

Table 423: Members

Property TBPTCount (p. 1328) Gets the number of


values.
Property TBPTValues (p. 1328) Gets the TBPT values.
Property Temp (p. 1329) Gets the temperature.

TBPTCount
Gets the number of values.

Declaration Syntax
public int TBPTCount { get; }

TBPTValues
Gets the TBPT values.

Declaration Syntax
public IReadOnlyList<TBPTValues> TBPTValues { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1328 of ANSYS, Inc. and its subsidiaries and affiliates.
TBPTValues

Temp
Gets the temperature.

Declaration Syntax
public double Temp { get; }

TBPTValues
Represents a tuple of values for the TBPT commmand.

Declaration Syntax
public class TBPTValues

Table 424: Members

Property ValueCount (p. 1329) Gets the number of


values.
Property Values (p. 1329) Gets the values.

ValueCount
Gets the number of values.

Declaration Syntax
public int ValueCount { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1329
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1330 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.FE.ABAQUS
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.FE.ABAQUS

Table 425: Members

AbaqusKeyword (p. 1331) Represents an Abaqus keyword (with arguments and data
lines).
AbaqusKeywordArgument (p. 1332) Represents a keyword argument (with Key and Value).
AbaqusKeywordArgumentColl (p. 1332) Collection of keyword arguments.
AbaqusKeywordDataLine (p. 1333) Represents a keyword data line.
AbaqusKeywordDataLineColl (p. 1333) Collection of keyword data lines.

AbaqusKeyword
Represents an Abaqus keyword (with arguments and data lines).

Declaration Syntax
public class AbaqusKeyword : ABAQUSCommand

Table 426: Members

Property Arguments (p. 1331) Gets the arguments.


Property DataLines (p. 1332) Gets the data lines.
Property Index (p. 1269) Gets the command index.

(Inherited from
Command (p. 1269).)
Property Name (p. 1269) Gets the command name.

(Inherited from
Command (p. 1269).)

Arguments
Gets the arguments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1331
Ansys.ACT.Automation.Mechanical.FE.ABAQUS Namespace

Declaration Syntax
public AbaqusKeywordArgumentColl Arguments { get; }

DataLines
Gets the data lines.

Declaration Syntax
public AbaqusKeywordDataLineColl DataLines { get; }

AbaqusKeywordArgument
Represents a keyword argument (with Key and Value).

Declaration Syntax
public class AbaqusKeywordArgument

Table 427: Members

Property Key (p. 1332) Gets the


Key.
Property Value (p. 1332) Gets the
Value.

Key
Gets the Key.

Declaration Syntax
public string Key { get; }

Value
Gets the Value.

Declaration Syntax
public string Value { get; }

AbaqusKeywordArgumentColl
Collection of keyword arguments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1332 of ANSYS, Inc. and its subsidiaries and affiliates.
AbaqusKeywordDataLineColl

Declaration Syntax
public class AbaqusKeywordArgumentColl

Table 428: Members

Property Items (p. 1333) Gets the list of


arguments.

Items
Gets the list of arguments.

Declaration Syntax
public IReadOnlyList<AbaqusKeywordArgument> Items { get; }

AbaqusKeywordDataLine
Represents a keyword data line.

Declaration Syntax
public class AbaqusKeywordDataLine

Table 429: Members

Property Items (p. 1333) Gets the data line


values.

Items
Gets the data line values.

Declaration Syntax
public IReadOnlyList<string> Items { get; }

AbaqusKeywordDataLineColl
Collection of keyword data lines.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1333
Ansys.ACT.Automation.Mechanical.FE.ABAQUS Namespace

Declaration Syntax
public class AbaqusKeywordDataLineColl

Table 430: Members

Property Items (p. 1334) Gets the list of data


lines.

Items
Gets the list of data lines.

Declaration Syntax
public IReadOnlyList<AbaqusKeywordDataLine> Items { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1334 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Substructure
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Substructure

Table 431: Members

ExportSettings (p. 1335) No details are provided for this


entry.

ExportSettings
No details are provided for this entry.

Declaration Syntax
public class ExportSettings : CPandSubstructureExportSettings

Table 432: Members

Constructor ExportSettings() (p. 1335) Creates a new SubstructureExportSettings


instance.

ExportSettings()
Creates a new SubstructureExportSettings instance.

Declaration Syntax
public ExportSettings()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1335
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1336 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results

Table 433: Members

Alert (p. 1338) Defines a Alert.


ContactDataTable (p. 1341) Defines a ContactDataTable.
Convergence (p. 1344) Defines a Convergence.
LatticeDensity (p. 1348) Defines a LatticeDensity.
LatticeElementalDensity (p. 1351) Defines a LatticeElementalDensity.
LinePressureResult (p. 1353) Defines a LinePressureResult.
MagneticCoenergy (p. 1357) Defines a MagneticCoenergy.
MagneticPotential (p. 1362) Defines a MagneticPotential.
NewtonRaphsonResidualCharge (p. 1366) Defines a
NewtonRaphsonResidualCharge.
NewtonRaphsonResidualForce (p. 1370) Defines a
NewtonRaphsonResidualForce.
NewtonRaphsonResidualHeat (p. 1374) Defines a
NewtonRaphsonResidualHeat.
NewtonRaphsonResidualMoment (p. 1378) Defines a
NewtonRaphsonResidualMoment.
Result (p. 1383) Defines a Result.
ResultChart (p. 1398) Defines a ResultChart.
ResultTable (p. 1411) Defines a ResultTable.
ShapeFinder (p. 1414) Defines a ShapeFinder.
ShapeFinderElemental (p. 1418) Defines a ShapeFinderElemental.
Smoothing (p. 1422) Defines a Smoothing.
TopologyDensity (p. 1424) Defines a TopologyDensity.
TopologyElementalDensity (p. 1427) Defines a TopologyElementalDensity.
TopologyOptimizationResult (p. 1430) Defines a
TopologyOptimizationResult.
UserDefinedResult (p. 1437) Defines a UserDefinedResult.
VariableGraph (p. 1453) Defines a VariableGraph.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1337
Ansys.ACT.Automation.Mechanical.Results Namespace

Volume (p. 1457) Defines a Volume.

Alert
Defines a Alert.

Declaration Syntax
public class Alert : DataModelObject, IFolderDataModelObject

Table 434: Members

Property Children (p. 1338) Gets the list of children.


Property Comments (p. 1338) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1339) Gets the current DataModelObject's category.
Property FailsIf (p. 1339) Gets or sets the FailsIf.
Property Images (p. 1339) Gets the list of associated images.
Property InternalObject (p. 1339) Gets the internal object. For advanced usage only.
Property Status (p. 1339) Gets the Status.
Property Value (p. 1339) Gets or sets the Value.
Method AddComment() (p. 1340) Creates a new child Comment.
Method AddImage(string) (p. 1340) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1340) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1340)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1341)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1338 of ANSYS, Inc. and its subsidiaries and affiliates.
Alert

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

FailsIf
Gets or sets the FailsIf.

Declaration Syntax
public MinimumOrMaximum FailsIf { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSAlertAuto InternalObject { get; }

Status
Gets the Status.

Declaration Syntax
public PassFailResult Status { get; }

Value
Gets or sets the Value.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1339
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public double Value { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1340 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDataTable

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ContactDataTable
Defines a ContactDataTable.

Declaration Syntax
public class ContactDataTable : DataModelObject, IFolderDataModelObject

Table 435: Members

Property Children (p. 1342) Gets the list of children.


Property Comments (p. 1342) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1342) Gets the current DataModelObject's
category.
Property Figures (p. 1342) Gets the list of associated figures.
Property InternalObject (p. 1342) Gets the internal object. For advanced usage
only.
Method AddComment() (p. 1343) Creates a new child Comment.
Method AddFigure() (p. 1343) Creates a new child Figure.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1341
Ansys.ACT.Automation.Mechanical.Results Namespace

Method Delete() (p. 1343) Run the Delete action.


Method ExportTextFile(string) (p. 1343) Run the ExportTextFile action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1343)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1344)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSContactDataTableAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1342 of ANSYS, Inc. and its subsidiaries and affiliates.
ContactDataTable

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ExportTextFile(string)
Run the ExportTextFile action.

Declaration Syntax
public virtual void ExportTextFile(string fileName)

Parameters
fileName(string)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1343
Ansys.ACT.Automation.Mechanical.Results Namespace

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Convergence
Defines a Convergence.

Declaration Syntax
public class Convergence : DataModelObject, IFolderDataModelObject

Table 436: Members

Property AllowableChange (p. 1345) Gets or sets the AllowableChange.


Property Children (p. 1345) Gets the list of children.
Property Comments (p. 1345) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1345) Gets the current DataModelObject's category.
Property Figures (p. 1346) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1344 of ANSYS, Inc. and its subsidiaries and affiliates.
Convergence

Property Images (p. 1346) Gets the list of associated images.


Property InternalObject (p. 1346) Gets the internal object. For advanced usage only.
Property IsConverged (p. 1346) Gets the IsConverged.
Property LastChange (p. 1346) Gets the LastChange.
Property Type (p. 1346) Gets or sets the Type.
Method AddComment() (p. 1347) Creates a new child Comment.
Method AddFigure() (p. 1347) Creates a new child Figure.
Method AddImage(string) (p. 1347) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1347) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1347)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1348)

AllowableChange
Gets or sets the AllowableChange.

Declaration Syntax
public double AllowableChange { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1345
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSConvergenceAuto InternalObject { get; }

IsConverged
Gets the IsConverged.

Declaration Syntax
public bool IsConverged { get; }

LastChange
Gets the LastChange.

Declaration Syntax
public double LastChange { get; }

Type
Gets or sets the Type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1346 of ANSYS, Inc. and its subsidiaries and affiliates.
Convergence

Declaration Syntax
public ConvergenceType Type { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1347
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

LatticeDensity
Defines a LatticeDensity.

Declaration Syntax
public class LatticeDensity : TopologyOptimizationResult

Table 437: Members

Property CalculateTimeHistory (p. 1431) Gets or sets the CalculateTimeHistory.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1348 of ANSYS, Inc. and its subsidiaries and affiliates.
LatticeDensity

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Children (p. 1431) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Comments (p. 1431) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property DataModelObjectCategory (p. 1350)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1431) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Figures (p. 1432) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalMass (p. 1432) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalVolume (p. 1432) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Images (p. 1432) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property InternalObject (p. 1350) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1432) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property IterationStep (p. 1433) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Location (p. 1433) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Maximum (p. 1433) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1430).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1349
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Minimum (p. 1433) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalMass (p. 1433) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalVolume (p. 1433) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentMassOfOriginal (p. 1434) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentVolumeOfOriginal (p. 1434) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property ScopingMethod (p. 1434) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Selection (p. 1434) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property ShowOptimizedRegion (p. 1434) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Suppressed (p. 1434) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1430).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1350 of ANSYS, Inc. and its subsidiaries and affiliates.
LatticeElementalDensity

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LatticeElementalDensity
Defines a LatticeElementalDensity.

Declaration Syntax
public class LatticeElementalDensity : TopologyOptimizationResult

Table 438: Members

Property CalculateTimeHistory (p. 1431) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Children (p. 1431) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Comments (p. 1431) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property DataModelObjectCategory (p. 1353)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1431) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Figures (p. 1432) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalMass (p. 1432) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalVolume (p. 1432) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Images (p. 1432) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property InternalObject (p. 1353) Gets the internal object. For advanced usage
only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1351
Ansys.ACT.Automation.Mechanical.Results Namespace

Property IterationNumber (p. 1432) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property IterationStep (p. 1433) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Location (p. 1433) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Maximum (p. 1433) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Minimum (p. 1433) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalMass (p. 1433) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalVolume (p. 1433) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentMassOfOriginal (p. 1434) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentVolumeOfOriginal (p. 1434) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property ScopingMethod (p. 1434) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Selection (p. 1434) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property ShowOptimizedRegion (p. 1434) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Suppressed (p. 1434) Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1352 of ANSYS, Inc. and its subsidiaries and affiliates.
LinePressureResult

(Inherited from
TopologyOptimizationResult (p. 1430).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LinePressureResult
Defines a LinePressureResult.

Declaration Syntax
public class LinePressureResult : Result

Table 439: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1353
Ansys.ACT.Automation.Mechanical.Results Namespace

Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1357) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1357) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1354 of ANSYS, Inc. and its subsidiaries and affiliates.
LinePressureResult

Property LinePressureResultBasedOn (p. 1357) Gets or sets the


LinePressureResultBasedOn.
Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1355
Ansys.ACT.Automation.Mechanical.Results Namespace

Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1356 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticCoenergy

Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LinePressureResultBasedOn
Gets or sets the LinePressureResultBasedOn.

Declaration Syntax
public LinePressureResultBasedOnType LinePressureResultBasedOn { set;get; }

MagneticCoenergy
Defines a MagneticCoenergy.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1357
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class MagneticCoenergy : Result

Table 440: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1361) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1358 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticCoenergy

Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1361) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1359
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1360 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticCoenergy

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1361
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MagneticPotential
Defines a MagneticPotential.

Declaration Syntax
public class MagneticPotential : Result

Table 441: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1365) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1362 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticPotential

Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1366) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1363
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1364 of ANSYS, Inc. and its subsidiaries and affiliates.
MagneticPotential

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1365
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NewtonRaphsonResidualCharge
Defines a NewtonRaphsonResidualCharge.

Declaration Syntax
public class NewtonRaphsonResidualCharge : Result

Table 442: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1366 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualCharge

Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1370) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1370) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1367
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1368 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualCharge

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1369
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NewtonRaphsonResidualForce
Defines a NewtonRaphsonResidualForce.

Declaration Syntax
public class NewtonRaphsonResidualForce : Result

Table 443: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1370 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualForce

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1374) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1374) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1371
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1372 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualForce

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1373
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NewtonRaphsonResidualHeat
Defines a NewtonRaphsonResidualHeat.

Declaration Syntax
public class NewtonRaphsonResidualHeat : Result

Table 444: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1374 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualHeat

Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1378) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1378) Gets the internal object. For advanced
usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1375
Ansys.ACT.Automation.Mechanical.Results Namespace

Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1376 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualHeat

Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1377
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NewtonRaphsonResidualMoment
Defines a NewtonRaphsonResidualMoment.

Declaration Syntax
public class NewtonRaphsonResidualMoment : Result

Table 445: Members

Property Average (p. 1385) Gets the Average.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1378 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualMoment

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1382) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1379
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1382) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1380 of ANSYS, Inc. and its subsidiaries and affiliates.
NewtonRaphsonResidualMoment

Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1381
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1382 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Result
Defines a Result.

Declaration Syntax
public abstract class Result : DataModelObject, IFolderDataModelObject

Table 446: Members

Property Average (p. 1385) Gets the Average.


Property By (p. 1385) Gets or sets the By.
Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.
Property Children (p. 1386) Gets the list of children.
Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.
Property Comments (p. 1386) Gets the list of associated comments.
Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.
Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.
Property DataModelObjectCategory (p. 1387) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.
Property DisplayTime (p. 1387) Gets or sets the DisplayTime.
Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.
Property Figures (p. 1387) Gets the list of associated figures.
Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.
Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.
Property Identifier (p. 1388) Gets or sets the Identifier.
Property Images (p. 1388) Gets the list of associated images.
Property InternalObject (p. 1388) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.
Property ItemType (p. 1388) Gets or sets the ItemType.
Property IterationNumber (p. 1389) Gets the IterationNumber.
Property LoadStep (p. 1389) Gets the LoadStep.
Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.
Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1383
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.
Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.
Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.
Property Location (p. 1390) Gets or sets the Location.
Property Maximum (p. 1390) Gets the Maximum.
Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.
Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.
Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.
Property Minimum (p. 1391) Gets the Minimum.
Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.
Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.
Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.
Property NamedSelections (p. 1391) Gets or sets the NamedSelections.
Property Path (p. 1391) No details are provided for this entry.
Property PlotData (p. 1392) Gets the result table.
Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.
Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.
Property SetNumber (p. 1392) Gets or sets the Set Number.
Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.
Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.
Property Substep (p. 1393) Gets the Substep.
Property Suppressed (p. 1393) Gets or sets the Suppressed.
Property Surface (p. 1393) No details are provided for this entry.
Property SurfaceCoating (p. 1393) No details are provided for this entry.
Property Time (p. 1393) Gets the Time.
Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.
Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.
Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.
Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.
Property Total (p. 1394) Gets the Total.
Method AddAlert() (p. 1394) Creates a new Alert
Method AddComment() (p. 1394) Creates a new child Comment.
Method AddConvergence() (p. 1395) Creates a new Convergence

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1384 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Method AddFigure() (p. 1395) Creates a new child Figure.


Method AddImage(string) (p. 1395) Creates a new child Image. If a filePath is
provided, the image will be loaded from
that file, if not, the image will be a screen
capture of the Geometry window.
Method ClearGeneratedData() (p. 1395) Run the ClearGeneratedData action.
Method CreateResultsAtAllSets() (p. 1395) Creates results at all sets for results under
a solution.
Method Delete() (p. 1396) Run the Delete action.
Method DuplicateWithoutResults() (p. 1396) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 1396) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1396)
Method ExportToTextFile(string) (p. 1397) Run the ExportToTextFile action.
Method FetchRemoteResults() (p. 1397) Run the FetchRemoteResult action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1397)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1397)
Method PromoteToNamedSelection() (p. 1398) Run the PromoteToNamedSelection
action.
Method RenameBasedOnDefinition() (p. 1398) Run the RenameBasedOnDefinition action.

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

By
Gets or sets the By.

Declaration Syntax
public SetDriverStyle By { set;get; }

CalculateTimeHistory
Gets or sets the CalculateTimeHistory.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1385
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public bool CalculateTimeHistory { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

CombinationNumber
Gets or sets the Combination Number for a Solution Combination result.

Declaration Syntax
public uint CombinationNumber { set;get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the
general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub
scoped by ply.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CrackFrontNumber
Gets or sets the CrackFrontNumber.

Declaration Syntax
public int CrackFrontNumber { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1386 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DisplayOption
Gets or sets the DisplayOption.

Declaration Syntax
public ResultAveragingType DisplayOption { set;get; }

DisplayTime
Gets or sets the DisplayTime.

Declaration Syntax
public Quantity DisplayTime { set;get; }

DpfEvaluation
Gets or sets the DpfEvaluation.

Declaration Syntax
public DpfEvaluationType DpfEvaluation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GlobalIDs
Gets or sets the GlobalIDs.

Declaration Syntax
public string GlobalIDs { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1387
Ansys.ACT.Automation.Mechanical.Results Namespace

GraphControlsXAxis
Gets or sets the GraphControlsXAxis.

Declaration Syntax
public GraphControlsXAxis GraphControlsXAxis { set;get; }

Identifier
Gets or sets the Identifier.

Declaration Syntax
public string Identifier { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

IsSolved
Gets the IsSolved.

Declaration Syntax
public bool IsSolved { get; }

ItemType
Gets or sets the ItemType.

Declaration Syntax
public ResultFileItemType ItemType { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1388 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

IterationNumber
Gets the IterationNumber.

Declaration Syntax
public int IterationNumber { get; }

LoadStep
Gets the LoadStep.

Declaration Syntax
public int LoadStep { get; }

LoadStepForMaximumOfMaximumValues
Get the Load Step for the maximum of maximum values.

Declaration Syntax
public uint LoadStepForMaximumOfMaximumValues { get; }

LoadStepForMaximumOfMinimumValues
Get the Load Step for the maximum of minimum values.

Declaration Syntax
public uint LoadStepForMaximumOfMinimumValues { get; }

LoadStepForMinimumOfMaximumValues
Get the Load Step for the minimum of maximum values.

Declaration Syntax
public uint LoadStepForMinimumOfMaximumValues { get; }

LoadStepForMinimumOfMinimumValues
Get the Load Step for the minimum of minimum values.

Declaration Syntax
public uint LoadStepForMinimumOfMinimumValues { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1389
Ansys.ACT.Automation.Mechanical.Results Namespace

LoadStepNumber
Gets or sets the LoadStepNumber.

Declaration Syntax
public uint LoadStepNumber { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

MaximumOccursOn
Gets the MaximumOccursOn.

Declaration Syntax
public string MaximumOccursOn { get; }

MaximumOfMaximumOverTime
Gets the MaximumOfMaximumOverTime.

Declaration Syntax
public Quantity MaximumOfMaximumOverTime { get; }

MaximumOfMinimumOverTime
Gets the MaximumOfMinimumOverTime.

Declaration Syntax
public Quantity MaximumOfMinimumOverTime { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1390 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumOccursOn
Gets the MinimumOccursOn.

Declaration Syntax
public string MinimumOccursOn { get; }

MinimumOfMaximumOverTime
Gets the MinimumOfMaximumOverTime.

Declaration Syntax
public Quantity MinimumOfMaximumOverTime { get; }

MinimumOfMinimumOverTime
Gets the MinimumOfMinimumOverTime.

Declaration Syntax
public Quantity MinimumOfMinimumOverTime { get; }

NamedSelections
Gets or sets the NamedSelections.

Declaration Syntax
public IEnumerable<IDataModelObject> NamedSelections { set;get; }

Path
No details are provided for this entry.

Declaration Syntax
public Path Path { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1391
Ansys.ACT.Automation.Mechanical.Results Namespace

PlotData
Gets the result table.

Declaration Syntax
public ResultDataTable PlotData { get; }

RPMSelection
Gets or sets the RPM Selection value at which the results are evaluated.

Declaration Syntax
public Quantity RPMSelection { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SetNumber
Gets or sets the Set Number.

Declaration Syntax
public uint SetNumber { set;get; }

SolutionCombinationDriver
Gets or sets the SolutionCombinationDriver.

Declaration Syntax
public SolutionCombinationDriverStyle SolutionCombinationDriver { set;get; }

SolverComponentIDs
Gets or sets the SolverComponentIDs.

Declaration Syntax
public string SolverComponentIDs { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1392 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

Substep
Gets the Substep.

Declaration Syntax
public int Substep { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Surface
No details are provided for this entry.

Declaration Syntax
public Surface Surface { set;get; }

SurfaceCoating
No details are provided for this entry.

Declaration Syntax
public SurfaceCoating SurfaceCoating { set;get; }

Time
Gets the Time.

Declaration Syntax
public Quantity Time { get; }

TimeForMaximumOfMaximumValues
Get the Time for the maximum of maximum values.

Declaration Syntax
public Quantity TimeForMaximumOfMaximumValues { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1393
Ansys.ACT.Automation.Mechanical.Results Namespace

TimeForMaximumOfMinimumValues
Get the Time for the maximum of minimum values.

Declaration Syntax
public Quantity TimeForMaximumOfMinimumValues { get; }

TimeForMinimumOfMaximumValues
Get the Time for the minimum of maximum values.

Declaration Syntax
public Quantity TimeForMinimumOfMaximumValues { get; }

TimeForMinimumOfMinimumValues
Get the Time for the minimum of minimum values.

Declaration Syntax
public Quantity TimeForMinimumOfMinimumValues { get; }

Total
Gets the Total.

Declaration Syntax
public Quantity Total { get; }

AddAlert()
Creates a new Alert

Declaration Syntax
public virtual Alert AddAlert()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1394 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

AddConvergence()
Creates a new Convergence

Declaration Syntax
public virtual Convergence AddConvergence()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateResultsAtAllSets()
Creates results at all sets for results under a solution.

Declaration Syntax
public virtual List<IDataModelObject> CreateResultsAtAllSets()

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1395
Ansys.ACT.Automation.Mechanical.Results Namespace

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DuplicateWithoutResults()
Run the DuplicateWithoutResults action.

Declaration Syntax
public virtual IDataModelObject DuplicateWithoutResults()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

ExportAnimation(string, GraphicsAnimationExportFormat, AnimationEx-


portSettings)
Run the ExportAnimation action.

Declaration Syntax
public virtual void ExportAnimation(string filePath, GraphicsAnimationExportFormat format, Anima-
tionExportSettings settings)

Parameters
filePath(string)

No details are provided for this entry.

format(GraphicsAnimationExportFormat)

No details are provided for this entry.

settings(AnimationExportSettings)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1396 of ANSYS, Inc. and its subsidiaries and affiliates.
Result

ExportToTextFile(string)
Run the ExportToTextFile action.

Declaration Syntax
public virtual void ExportToTextFile(string filePath)

Parameters
filePath(string)

No details are provided for this entry.

FetchRemoteResults()
Run the FetchRemoteResult action.

Declaration Syntax
public virtual void FetchRemoteResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1397
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

PromoteToNamedSelection()
Run the PromoteToNamedSelection action.

Declaration Syntax
public virtual IEnumerable<NamedSelection> PromoteToNamedSelection()

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

ResultChart
Defines a ResultChart.

Declaration Syntax
public abstract class ResultChart : DataModelObject, IFolderDataModelObject

Table 447: Members

Property AccelerationType (p. 1400) Gets or sets the AccelerationType.


Property BoundaryCondition (p. 1400) Gets or sets the BoundaryCondition.
Property ChartDimensions (p. 1400) Gets or sets the Chart Dimensions

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1398 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Property ChartViewingStyle (p. 1401) Gets or sets the ChartViewingStyle.


Property Children (p. 1401) Gets the list of children.
Property Comments (p. 1401) Gets the list of associated comments.
Property CoordinateSystem (p. 1401) Gets or sets the CoordinateSystem.
Property CurvesAppearanceDisplay (p. 1401) Gets or sets the CurvesAppearanceDisplay.
Property CutFrequency (p. 1401) Gets or sets the CutFrequency.
Property DataModelObjectCategory (p. 1402) Gets the current DataModelObject's category.
Property DeformationType (p. 1402) Gets or sets the DeformationType.
Property DpfEvaluation (p. 1402) Gets or sets the DpfEvaluation.
Property Duration (p. 1402) Gets or sets the Duration.
Property EnhancedTracking (p. 1402) Gets the EnhancedTracking.
Property FilterMaximum (p. 1402) Gets the FilterMaximum.
Property FilterMinimum (p. 1403) Gets the FilterMinimum.
Property FilterType (p. 1403) Gets or sets the FilterType.
Property FrequencyAtMaximumAmplitude (p. 1403)Gets the FrequencyAtMaximumAmplitude.
Property GeometrySelectionString (p. 1403) Gets or sets the GeometrySelectionString.
Property Images (p. 1403) Gets the list of associated images.
Property ImaginaryAtMaximumAmplitude (p. 1403)Gets the ImaginaryAtMaximumAmplitude.
Property InternalObject (p. 1404) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1404) Gets the IsSolved.
Property LoadStepNumber (p. 1404) Gets or sets the LoadStepNumber.
Property Location (p. 1404) Gets or sets the Location.
Property Maximum (p. 1404) Gets the Maximum.
Property MaximumAmplitude (p. 1404) Gets the MaximumAmplitude.
Property MaximumFrequency (p. 1405) Gets or sets the MaximumFrequency.
Property Minimum (p. 1405) Gets the Minimum.
Property MinimumFrequency (p. 1405) Gets or sets the MinimumFrequency.
Property NamedSelections (p. 1405) Gets or sets the NamedSelections.
Property NormalOrientation (p. 1405) Gets or sets the NormalOrientation.
Property PhaseAngle (p. 1405) Gets the PhaseAngle.
Property RealAtMaximumAmplitude (p. 1406) Gets the RealAtMaximumAmplitude.
Property ReportedFrequency (p. 1406) Gets the ReportedFrequency.
Property RequestedFrequency (p. 1406) Gets or sets the RequestedFrequency.
Property ResultChartType (p. 1406) Gets the ResultChartType.
Property RPMSelection (p. 1406) Gets or sets the RPM Selection value at which the
results are evaluated.
Property SectorNumber (p. 1406) Gets or sets the SectorNumber.
Property ShearOrientation (p. 1407) Gets or sets the ShearOrientation.
Property SpatialResolution (p. 1407) Gets or sets the SpatialResolution.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1399
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Spring (p. 1407) Gets or sets the Spring.


Property StressStrainType (p. 1407) Gets or sets the StressStrainType.
Property Suppressed (p. 1407) Gets or sets the Suppressed.
Property TimeHistoryDisplay (p. 1407) Gets or sets the TimeHistoryDisplay.
Property UseParentFrequencyRange (p. 1408) Gets or sets the UseParentFrequencyRange.
Property VelocityType (p. 1408) Gets or sets the VelocityType.
Property XAxisValues (p. 1408) Gets or sets the XAxisValues.
Method AddComment() (p. 1408) Creates a new child Comment.
Method AddImage(string) (p. 1408) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 1409) Run the ClearGeneratedData action.
Method Delete() (p. 1409) Run the Delete action.
Method EvaluateAllResults() (p. 1409) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1409)
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1410)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1410)
Method RenameBasedOnDefinition() (p. 1410) Run the RenameBasedOnDefinition action.

AccelerationType
Gets or sets the AccelerationType.

Declaration Syntax
public TotalOrDirectional AccelerationType { set;get; }

BoundaryCondition
Gets or sets the BoundaryCondition.

Declaration Syntax
public GenericBoundaryCondition BoundaryCondition { set;get; }

ChartDimensions
Gets or sets the Chart Dimensions

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1400 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Declaration Syntax
public ChartDimensions ChartDimensions { set;get; }

ChartViewingStyle
Gets or sets the ChartViewingStyle.

Declaration Syntax
public ChartAxisScaleType ChartViewingStyle { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CurvesAppearanceDisplay
Gets or sets the CurvesAppearanceDisplay.

Declaration Syntax
public ChartPlotStyle CurvesAppearanceDisplay { set;get; }

CutFrequency
Gets or sets the CutFrequency.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1401
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public double CutFrequency { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DeformationType
Gets or sets the DeformationType.

Declaration Syntax
public TotalOrDirectional DeformationType { set;get; }

DpfEvaluation
Gets or sets the DpfEvaluation.

Declaration Syntax
public DpfEvaluationType DpfEvaluation { set;get; }

Duration
Gets or sets the Duration.

Declaration Syntax
public Quantity Duration { set;get; }

EnhancedTracking
Gets the EnhancedTracking.

Declaration Syntax
public bool EnhancedTracking { get; }

FilterMaximum
Gets the FilterMaximum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1402 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Declaration Syntax
public Quantity FilterMaximum { get; }

FilterMinimum
Gets the FilterMinimum.

Declaration Syntax
public Quantity FilterMinimum { get; }

FilterType
Gets or sets the FilterType.

Declaration Syntax
public FilterType FilterType { set;get; }

FrequencyAtMaximumAmplitude
Gets the FrequencyAtMaximumAmplitude.

Declaration Syntax
public Quantity FrequencyAtMaximumAmplitude { get; }

GeometrySelectionString
Gets or sets the GeometrySelectionString.

Declaration Syntax
public string GeometrySelectionString { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImaginaryAtMaximumAmplitude
Gets the ImaginaryAtMaximumAmplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1403
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public Quantity ImaginaryAtMaximumAmplitude { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

IsSolved
Gets the IsSolved.

Declaration Syntax
public bool IsSolved { get; }

LoadStepNumber
Gets or sets the LoadStepNumber.

Declaration Syntax
public uint LoadStepNumber { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public Quantity Maximum { get; }

MaximumAmplitude
Gets the MaximumAmplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1404 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Declaration Syntax
public Quantity MaximumAmplitude { get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

NamedSelections
Gets or sets the NamedSelections.

Declaration Syntax
public IEnumerable<IDataModelObject> NamedSelections { set;get; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

PhaseAngle
Gets the PhaseAngle.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1405
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public Quantity PhaseAngle { get; }

RealAtMaximumAmplitude
Gets the RealAtMaximumAmplitude.

Declaration Syntax
public Quantity RealAtMaximumAmplitude { get; }

ReportedFrequency
Gets the ReportedFrequency.

Declaration Syntax
public Quantity ReportedFrequency { get; }

RequestedFrequency
Gets or sets the RequestedFrequency.

Declaration Syntax
public Quantity RequestedFrequency { set;get; }

ResultChartType
Gets the ResultChartType.

Declaration Syntax
public ChartResultType ResultChartType { get; }

RPMSelection
Gets or sets the RPM Selection value at which the results are evaluated.

Declaration Syntax
public Quantity RPMSelection { set;get; }

SectorNumber
Gets or sets the SectorNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1406 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Declaration Syntax
public int SectorNumber { set;get; }

ShearOrientation
Gets or sets the ShearOrientation.

Declaration Syntax
public ShearOrientationType ShearOrientation { set;get; }

SpatialResolution
Gets or sets the SpatialResolution.

Declaration Syntax
public MultipleNodeType SpatialResolution { set;get; }

Spring
Gets or sets the Spring.

Declaration Syntax
public Spring Spring { set;get; }

StressStrainType
Gets or sets the StressStrainType.

Declaration Syntax
public StressStrainType StressStrainType { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TimeHistoryDisplay
Gets or sets the TimeHistoryDisplay.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1407
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public TimeHistoryDisplayType TimeHistoryDisplay { set;get; }

UseParentFrequencyRange
Gets or sets the UseParentFrequencyRange.

Declaration Syntax
public bool UseParentFrequencyRange { set;get; }

VelocityType
Gets or sets the VelocityType.

Declaration Syntax
public TotalOrDirectional VelocityType { set;get; }

XAxisValues
Gets or sets the XAxisValues.

Declaration Syntax
public XAxisValues XAxisValues { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1408 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultChart

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

ExportAnimation(string, GraphicsAnimationExportFormat, AnimationEx-


portSettings)
Run the ExportAnimation action.

Declaration Syntax
public virtual void ExportAnimation(string filePath, GraphicsAnimationExportFormat format, Anima-
tionExportSettings settings)

Parameters
filePath(string)

No details are provided for this entry.

format(GraphicsAnimationExportFormat)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1409
Ansys.ACT.Automation.Mechanical.Results Namespace

settings(AnimationExportSettings)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1410 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultTable

Declaration Syntax
public virtual void RenameBasedOnDefinition()

ResultTable
Defines a ResultTable.

Declaration Syntax
public class ResultTable : DataModelObject, IFolderDataModelObject

Table 448: Members

Property Children (p. 1411) Gets the list of children.


Property Comments (p. 1411) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1412) Gets the current DataModelObject's category.
Property Images (p. 1412) Gets the list of associated images.
Property InternalObject (p. 1412) Gets the internal object. For advanced usage only.
Property Multiplier (p. 1412) Gets or sets the Multiplier.
Method AddComment() (p. 1412) Creates a new child Comment.
Method AddImage(string) (p. 1412) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method Delete() (p. 1413) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1413)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1413)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1411
Ansys.ACT.Automation.Mechanical.Results Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultTableAuto InternalObject { get; }

Multiplier
Gets or sets the Multiplier.

Declaration Syntax
public double Multiplier { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1412 of ANSYS, Inc. and its subsidiaries and affiliates.
ResultTable

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1413
Ansys.ACT.Automation.Mechanical.Results Namespace

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

ShapeFinder
Defines a ShapeFinder.

Declaration Syntax
public class ShapeFinder : Result

Table 449: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1414 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinder

Property DataModelObjectCategory (p. 1418) Gets the current DataModelObject's


category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1418) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1415
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1416 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinder

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1417
Ansys.ACT.Automation.Mechanical.Results Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

ShapeFinderElemental
Defines a ShapeFinderElemental.

Declaration Syntax
public class ShapeFinderElemental : Result

Table 450: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1418 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinderElemental

applicable). Accepts/Returns None for


Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1422) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1422) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1419
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1420 of ANSYS, Inc. and its subsidiaries and affiliates.
ShapeFinderElemental

Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1421
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Smoothing
Defines a Smoothing.

Declaration Syntax
public class Smoothing : GeometryFileContainer

Table 451: Members

Property Children (p. 592) Gets the list of children.

(Inherited from
GeometryFileContainer (p. 591).)
Property Comments (p. 592) Gets the list of associated comments.

(Inherited from
GeometryFileContainer (p. 591).)
Property DataModelObjectCategory (p. 1423)Gets the current DataModelObject's
category.
Property ExportModel (p. 1423) Gets or sets the ExportModel.
Property Figures (p. 592) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1422 of ANSYS, Inc. and its subsidiaries and affiliates.
Smoothing

(Inherited from
GeometryFileContainer (p. 591).)
Property FileName (p. 1423) Gets the FileName.
Property Images (p. 592) Gets the list of associated images.

(Inherited from
GeometryFileContainer (p. 591).)
Property InternalObject (p. 1424) Gets the internal object. For advanced usage
only.
Property LengthUnits (p. 593) Gets or sets the LengthUnits.

(Inherited from
GeometryFileContainer (p. 591).)
Property MoveLimit (p. 1424) Gets or sets the MoveLimit.
Property ShowAlways (p. 593) Gets or sets the ShowAlways.

(Inherited from
GeometryFileContainer (p. 591).)
Property Statistics (p. 593) Gets the Statistics.

(Inherited from
GeometryFileContainer (p. 591).)
Property Suppressed (p. 593) Gets or sets the Suppressed.

(Inherited from
GeometryFileContainer (p. 591).)
Method Evaluate() (p. 1424) Run the Evaluate action.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ExportModel
Gets or sets the ExportModel.

Declaration Syntax
public bool ExportModel { set;get; }

FileName
Gets the FileName.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1423
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public string FileName { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeometryFileContainerAuto InternalObject { get; }

MoveLimit
Gets or sets the MoveLimit.

Declaration Syntax
public double MoveLimit { set;get; }

Evaluate()
Run the Evaluate action.

Declaration Syntax
public virtual void Evaluate()

TopologyDensity
Defines a TopologyDensity.

Declaration Syntax
public class TopologyDensity : TopologyOptimizationResult

Table 452: Members

Property CalculateTimeHistory (p. 1431) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Children (p. 1431) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Comments (p. 1431) Gets the list of associated comments.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1424 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyDensity

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property DataModelObjectCategory (p. 1426)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1431) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Figures (p. 1432) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalMass (p. 1432) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalVolume (p. 1432) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Images (p. 1432) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property InternalObject (p. 1426) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1432) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property IterationStep (p. 1433) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Location (p. 1433) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Maximum (p. 1433) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Minimum (p. 1433) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalMass (p. 1433) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1425
Ansys.ACT.Automation.Mechanical.Results Namespace

Property OriginalVolume (p. 1433) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentMassOfOriginal (p. 1434) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentVolumeOfOriginal (p. 1434) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property RetainedThreshold (p. 1427) Gets or sets the RetainedThreshold.
Property ScopingMethod (p. 1434) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Selection (p. 1434) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property ShowOptimizedRegion (p. 1434) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Suppressed (p. 1434) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Method AddSmoothing() (p. 1427) Creates a new Smoothing
Method InsertSmoothing() (p. 1427) Insert Smoothing Object

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1426 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyElementalDensity

RetainedThreshold
Gets or sets the RetainedThreshold.

Declaration Syntax
public double RetainedThreshold { set;get; }

AddSmoothing()
Creates a new Smoothing

Declaration Syntax
public virtual Smoothing AddSmoothing()

InsertSmoothing()
Insert Smoothing Object

Declaration Syntax
public virtual void InsertSmoothing()

TopologyElementalDensity
Defines a TopologyElementalDensity.

Declaration Syntax
public class TopologyElementalDensity : TopologyOptimizationResult

Table 453: Members

Property CalculateTimeHistory (p. 1431) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Children (p. 1431) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Comments (p. 1431) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property DataModelObjectCategory (p. 1429)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1431) Gets or sets the ExclusionsParticipation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1427
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Figures (p. 1432) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalMass (p. 1432) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property FinalVolume (p. 1432) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Images (p. 1432) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property InternalObject (p. 1429) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1432) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property IterationStep (p. 1433) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Location (p. 1433) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Maximum (p. 1433) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Minimum (p. 1433) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalMass (p. 1433) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property OriginalVolume (p. 1433) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentMassOfOriginal (p. 1434) Gets the PercentMassOfOriginal.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1428 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyElementalDensity

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property PercentVolumeOfOriginal (p. 1434) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property RetainedThreshold (p. 1429) Gets or sets the RetainedThreshold.
Property ScopingMethod (p. 1434) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Selection (p. 1434) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property ShowOptimizedRegion (p. 1434) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1430).)
Property Suppressed (p. 1434) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1430).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

RetainedThreshold
Gets or sets the RetainedThreshold.

Declaration Syntax
public double RetainedThreshold { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1429
Ansys.ACT.Automation.Mechanical.Results Namespace

TopologyOptimizationResult
Defines a TopologyOptimizationResult.

Declaration Syntax
public abstract class TopologyOptimizationResult : DataModelObject, IFolderDataModelObject

Table 454: Members

Property CalculateTimeHistory (p. 1431) Gets or sets the CalculateTimeHistory.


Property Children (p. 1431) Gets the list of children.
Property Comments (p. 1431) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1431) Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1431) Gets or sets the ExclusionsParticipation.
Property Figures (p. 1432) Gets the list of associated figures.
Property FinalMass (p. 1432) Gets the FinalMass.
Property FinalVolume (p. 1432) Gets the FinalVolume.
Property Images (p. 1432) Gets the list of associated images.
Property InternalObject (p. 1432) Gets the internal object. For advanced usage only.
Property IterationNumber (p. 1432) Gets the IterationNumber.
Property IterationStep (p. 1433) Gets or sets the IterationStep.
Property Location (p. 1433) Gets or sets the Location.
Property Maximum (p. 1433) Gets the Maximum.
Property Minimum (p. 1433) Gets the Minimum.
Property OriginalMass (p. 1433) Gets the OriginalMass.
Property OriginalVolume (p. 1433) Gets the OriginalVolume.
Property PercentMassOfOriginal (p. 1434) Gets the PercentMassOfOriginal.
Property PercentVolumeOfOriginal (p. 1434) Gets the PercentVolumeOfOriginal.
Property ScopingMethod (p. 1434) Gets or sets the ScopingMethod.
Property Selection (p. 1434) Gets or sets the Selection.
Property ShowOptimizedRegion (p. 1434) Gets or sets the ShowOptimizedRegion.
Property Suppressed (p. 1434) Gets or sets the Suppressed.
Method AddComment() (p. 1435) Creates a new child Comment.
Method AddFigure() (p. 1435) Creates a new child Figure.
Method AddImage(string) (p. 1435) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 1435) Clears the result.
Method Delete() (p. 1435) Run the Delete action.
Method EvaluateAllResults() (p. 1436) Run the EvaluateAllResults action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1430 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyOptimizationResult

Method ExportAnimation(string, Run the ExportAnimation action.


GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1436)
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1436)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1437)
Method RenameBasedOnDefinition() (p. 1437) Run the RenameBasedOnDefinition action.

CalculateTimeHistory
Gets or sets the CalculateTimeHistory.

Declaration Syntax
public bool CalculateTimeHistory { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ExclusionsParticipation
Gets or sets the ExclusionsParticipation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1431
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public bool ExclusionsParticipation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

FinalMass
Gets the FinalMass.

Declaration Syntax
public Quantity FinalMass { get; }

FinalVolume
Gets the FinalVolume.

Declaration Syntax
public Quantity FinalVolume { get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

IterationNumber
Gets the IterationNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1432 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyOptimizationResult

Declaration Syntax
public int IterationNumber { get; }

IterationStep
Gets or sets the IterationStep.

Declaration Syntax
public int IterationStep { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public double Minimum { get; }

OriginalMass
Gets the OriginalMass.

Declaration Syntax
public Quantity OriginalMass { get; }

OriginalVolume
Gets the OriginalVolume.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1433
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public Quantity OriginalVolume { get; }

PercentMassOfOriginal
Gets the PercentMassOfOriginal.

Declaration Syntax
public double PercentMassOfOriginal { get; }

PercentVolumeOfOriginal
Gets the PercentVolumeOfOriginal.

Declaration Syntax
public double PercentVolumeOfOriginal { get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Selection
Gets or sets the Selection.

Declaration Syntax
public OptimizationRegion Selection { set;get; }

ShowOptimizedRegion
Gets or sets the ShowOptimizedRegion.

Declaration Syntax
public TopologyOptimizationResultShowType ShowOptimizedRegion { set;get; }

Suppressed
Gets or sets the Suppressed.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1434 of ANSYS, Inc. and its subsidiaries and affiliates.
TopologyOptimizationResult

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Clears the result.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1435
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

ExportAnimation(string, GraphicsAnimationExportFormat, AnimationEx-


portSettings)
Run the ExportAnimation action.

Declaration Syntax
public virtual void ExportAnimation(string filePath, GraphicsAnimationExportFormat format, Anima-
tionExportSettings settings)

Parameters
filePath(string)

No details are provided for this entry.

format(GraphicsAnimationExportFormat)

No details are provided for this entry.

settings(AnimationExportSettings)

No details are provided for this entry.

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1436 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

UserDefinedResult
Defines a UserDefinedResult.

Declaration Syntax
public class UserDefinedResult : DataModelObject, IFolderDataModelObject

Table 455: Members

Property Average (p. 1440) Gets the Average.


Property AverageAcrossBodies (p. 1440) Gets or sets the AverageAcrossBodies.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1437
Ansys.ACT.Automation.Mechanical.Results Namespace

Property By (p. 1440) Gets or sets the By.


Property CalculateTimeHistory (p. 1440) Gets or sets the CalculateTimeHistory.
Property Children (p. 1440) Gets the list of children.
Property CombinationNumber (p. 1441) Gets or sets the Combination Number for a Solution
Combination result.
Property Comments (p. 1441) Gets the list of associated comments.
Property CoordinateSystem (p. 1441) Gets or sets the Coordinate System.
Accepts/Returns None for Solution Coordinate
System in the general case (if applicable).
Accepts/Returns None for Fiber Coordinate System
for a result that is sub scoped by ply.
Property CyclicMode (p. 1441) Gets or sets the CyclicMode.
Property DataModelObjectCategory (p. 1441) Gets the current DataModelObject's category.
Property DisplayOption (p. 1441) Gets or sets the DisplayOption.
Property DisplayTime (p. 1442) Gets or sets the DisplayTime.
Property Expression (p. 1442) Gets or sets the Expression.
Property Figures (p. 1442) Gets the list of associated figures.
Property GlobalIDs (p. 1442) Gets or sets the GlobalIDs.
Property GraphControlsXAxis (p. 1442) Gets or sets the GraphControlsXAxis.
Property Identifier (p. 1442) Gets or sets the Identifier.
Property Images (p. 1443) Gets the list of associated images.
Property InputUnitSystem (p. 1443) Gets the InputUnitSystem.
Property InternalObject (p. 1443) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1443) Gets the IsSolved.
Property ItemType (p. 1443) Gets or sets the ItemType.
Property IterationNumber (p. 1443) Gets the IterationNumber.
Property Layer (p. 1444) Gets or sets the Layer.
Property LoadMultiplier (p. 1444) Gets the LoadMultiplier.
Property LoadStep (p. 1444) Gets the LoadStep.
Property LoadStepNumber (p. 1444) Gets or sets the LoadStepNumber.
Property Location (p. 1444) Gets or sets the Location.
Property Maximum (p. 1444) Gets the Maximum.
Property MaximumOccursOn (p. 1445) Gets the MaximumOccursOn.
Property MaximumOfMaximumOverTime (p. 1445)Gets the MaximumOfMaximumOverTime.
Property MaximumOfMinimumOverTime (p. 1445)Gets the MaximumOfMinimumOverTime.
Property Minimum (p. 1445) Gets the Minimum.
Property MinimumOccursOn (p. 1445) Gets the MinimumOccursOn.
Property MinimumOfMaximumOverTime (p. 1445)Gets the MinimumOfMaximumOverTime.
Property MinimumOfMinimumOverTime (p. 1446)Gets the MinimumOfMinimumOverTime.
Property Mode (p. 1446) Gets or sets the Mode (Result Set Number).

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1438 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Property OutputUnit (p. 1446) Gets or sets the OutputUnit.


Property PhaseIncrement (p. 1446) Gets or sets the PhaseIncrement.
Property Plies (p. 1446) No details are provided for this entry.
Property PlotData (p. 1446) Gets the result table.
Property Ply (p. 1447) Gets or sets the Ply selection.
Property Position (p. 1447) Gets or sets the Position.
Property ReportedFrequency (p. 1447) Gets the ReportedFrequency.
Property RequestedFrequency (p. 1447) Gets or sets the RequestedFrequency.
Property ResponseType (p. 1447) Gets or sets the ResponseType.
Property RPMSelection (p. 1447) Gets or sets the RPM Selection value at which the
results are evaluated.
Property ScaleFactor (p. 1448) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1448) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 1448) Gets or sets the ScopingMethod.
Property SetNumber (p. 1448) Gets or sets the Set Number.
Property SolutionCombinationDriver (p. 1448) Gets or sets the SolutionCombinationDriver.
Property SolverComponentIDs (p. 1448) Gets or sets the SolverComponentIDs.
Property SubScopeBy (p. 1449) Gets or sets the SubScopeBy.
Property Substep (p. 1449) Gets the Substep.
Property Suppressed (p. 1449) Gets or sets the Suppressed.
Property SweepingPhase (p. 1449) Gets or sets the SweepingPhase.
Property Time (p. 1449) Gets the Time.
Property Type (p. 1449) Gets the Type.
Method AddComment() (p. 1450) Creates a new child Comment.
Method AddFigure() (p. 1450) Creates a new child Figure.
Method AddImage(string) (p. 1450) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry
window.
Method ClearGeneratedData() (p. 1450) Run the ClearGeneratedData action.
Method CreateResultsAtAllSets() (p. 1450) Creates results at all sets for results under a
solution.
Method Delete() (p. 1451) Run the Delete action.
Method DuplicateWithoutResults() (p. 1451) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 1451) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1451)
Method ExportToTextFile(string) (p. 1452) Run the ExportToTextFile action.
Method FetchRemoteResults() (p. 1452) Run the FetchRemoteResult action.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1439
Ansys.ACT.Automation.Mechanical.Results Namespace

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.


IList<ChildrenType>) (p. 1452)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1452)
Method PromoteToNamedSelection() (p. 1453) Run the PromoteToNamedSelection action.
Method RenameBasedOnDefinition() (p. 1453) Run the RenameBasedOnDefinition action.

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Declaration Syntax
public bool AverageAcrossBodies { set;get; }

By
Gets or sets the By.

Declaration Syntax
public SetDriverStyle By { set;get; }

CalculateTimeHistory
Gets or sets the CalculateTimeHistory.

Declaration Syntax
public bool CalculateTimeHistory { set;get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1440 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

CombinationNumber
Gets or sets the Combination Number for a Solution Combination result.

Declaration Syntax
public uint CombinationNumber { set;get; }

Comments
Gets the list of associated comments.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CoordinateSystem
Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the
general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub
scoped by ply.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

CyclicMode
Gets or sets the CyclicMode.

Declaration Syntax
public uint CyclicMode { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

DisplayOption
Gets or sets the DisplayOption.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1441
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public ResultAveragingType DisplayOption { set;get; }

DisplayTime
Gets or sets the DisplayTime.

Declaration Syntax
public Quantity DisplayTime { set;get; }

Expression
Gets or sets the Expression.

Declaration Syntax
public string Expression { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GlobalIDs
Gets or sets the GlobalIDs.

Declaration Syntax
public string GlobalIDs { set;get; }

GraphControlsXAxis
Gets or sets the GraphControlsXAxis.

Declaration Syntax
public GraphControlsXAxis GraphControlsXAxis { set;get; }

Identifier
Gets or sets the Identifier.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1442 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public string Identifier { set;get; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InputUnitSystem
Gets the InputUnitSystem.

Declaration Syntax
public WBUnitSystemType InputUnitSystem { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSCustomResultAuto InternalObject { get; }

IsSolved
Gets the IsSolved.

Declaration Syntax
public bool IsSolved { get; }

ItemType
Gets or sets the ItemType.

Declaration Syntax
public ResultFileItemType ItemType { set;get; }

IterationNumber
Gets the IterationNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1443
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public int IterationNumber { get; }

Layer
Gets or sets the Layer.

Declaration Syntax
public int Layer { set;get; }

LoadMultiplier
Gets the LoadMultiplier.

Declaration Syntax
public double LoadMultiplier { get; }

LoadStep
Gets the LoadStep.

Declaration Syntax
public int LoadStep { get; }

LoadStepNumber
Gets or sets the LoadStepNumber.

Declaration Syntax
public uint LoadStepNumber { set;get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;get; }

Maximum
Gets the Maximum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1444 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public Quantity Maximum { get; }

MaximumOccursOn
Gets the MaximumOccursOn.

Declaration Syntax
public string MaximumOccursOn { get; }

MaximumOfMaximumOverTime
Gets the MaximumOfMaximumOverTime.

Declaration Syntax
public Quantity MaximumOfMaximumOverTime { get; }

MaximumOfMinimumOverTime
Gets the MaximumOfMinimumOverTime.

Declaration Syntax
public Quantity MaximumOfMinimumOverTime { get; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumOccursOn
Gets the MinimumOccursOn.

Declaration Syntax
public string MinimumOccursOn { get; }

MinimumOfMaximumOverTime
Gets the MinimumOfMaximumOverTime.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1445
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public Quantity MinimumOfMaximumOverTime { get; }

MinimumOfMinimumOverTime
Gets the MinimumOfMinimumOverTime.

Declaration Syntax
public Quantity MinimumOfMinimumOverTime { get; }

Mode
Gets or sets the Mode (Result Set Number).

Declaration Syntax
public uint Mode { set;get; }

OutputUnit
Gets or sets the OutputUnit.

Declaration Syntax
public UnitCategoryType OutputUnit { set;get; }

PhaseIncrement
Gets or sets the PhaseIncrement.

Declaration Syntax
public Quantity PhaseIncrement { set;get; }

Plies
No details are provided for this entry.

Declaration Syntax
public IEnumerable<ImportedPliesCollection> Plies { set;get; }

PlotData
Gets the result table.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1446 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public ResultDataTable PlotData { get; }

Ply
Gets or sets the Ply selection.

Declaration Syntax
public IEnumerable<AnalysisPly> Ply { set;get; }

Position
Gets or sets the Position.

Declaration Syntax
public ShellFaceType Position { set;get; }

ReportedFrequency
Gets the ReportedFrequency.

Declaration Syntax
public Quantity ReportedFrequency { get; }

RequestedFrequency
Gets or sets the RequestedFrequency.

Declaration Syntax
public Quantity RequestedFrequency { set;get; }

ResponseType
Gets or sets the ResponseType.

Declaration Syntax
public CoreResultType ResponseType { set;get; }

RPMSelection
Gets or sets the RPM Selection value at which the results are evaluated.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1447
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public Quantity RPMSelection { set;get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public ScaleFactorType ScaleFactor { set;get; }

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Declaration Syntax
public double ScaleFactorValue { set;get; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SetNumber
Gets or sets the Set Number.

Declaration Syntax
public uint SetNumber { set;get; }

SolutionCombinationDriver
Gets or sets the SolutionCombinationDriver.

Declaration Syntax
public SolutionCombinationDriverStyle SolutionCombinationDriver { set;get; }

SolverComponentIDs
Gets or sets the SolverComponentIDs.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1448 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public string SolverComponentIDs { set;get; }

SubScopeBy
Gets or sets the SubScopeBy.

Declaration Syntax
public SubScopingDefineByType SubScopeBy { set;get; }

Substep
Gets the Substep.

Declaration Syntax
public int Substep { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

Time
Gets the Time.

Declaration Syntax
public Quantity Time { get; }

Type
Gets the Type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1449
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public string Type { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddImage(string)
Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the
image will be a screen capture of the Geometry window.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

CreateResultsAtAllSets()
Creates results at all sets for results under a solution.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1450 of ANSYS, Inc. and its subsidiaries and affiliates.
UserDefinedResult

Declaration Syntax
public virtual List<IDataModelObject> CreateResultsAtAllSets()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

DuplicateWithoutResults()
Run the DuplicateWithoutResults action.

Declaration Syntax
public virtual IDataModelObject DuplicateWithoutResults()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

ExportAnimation(string, GraphicsAnimationExportFormat, AnimationEx-


portSettings)
Run the ExportAnimation action.

Declaration Syntax
public virtual void ExportAnimation(string filePath, GraphicsAnimationExportFormat format, Anima-
tionExportSettings settings)

Parameters
filePath(string)

No details are provided for this entry.

format(GraphicsAnimationExportFormat)

No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1451
Ansys.ACT.Automation.Mechanical.Results Namespace

settings(AnimationExportSettings)

No details are provided for this entry.

ExportToTextFile(string)
Run the ExportToTextFile action.

Declaration Syntax
public virtual void ExportToTextFile(string filePath)

Parameters
filePath(string)

No details are provided for this entry.

FetchRemoteResults()
Run the FetchRemoteResult action.

Declaration Syntax
public virtual void FetchRemoteResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)


Gets the list of children, filtered by type.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1452 of ANSYS, Inc. and its subsidiaries and affiliates.
VariableGraph

Declaration Syntax
public virtual IList<IDataModelObject> GetChildren(DataModelObjectCategory category, bool recurses,
IList<IDataModelObject> children)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

PromoteToNamedSelection()
Run the PromoteToNamedSelection action.

Declaration Syntax
public virtual IEnumerable<NamedSelection> PromoteToNamedSelection()

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

VariableGraph
Defines a VariableGraph.

Declaration Syntax
public class VariableGraph : Result

Table 456: Members

Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1453
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1457) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1454 of ANSYS, Inc. and its subsidiaries and affiliates.
VariableGraph

Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1457) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1455
Ansys.ACT.Automation.Mechanical.Results Namespace

Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1456 of ANSYS, Inc. and its subsidiaries and affiliates.
Volume

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Volume
Defines a Volume.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1457
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public class Volume : Result

Table 457: Members

Property Amplitude (p. 1461) Gets or sets the Amplitude.


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property DataModelObjectCategory (p. 1462) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property Figures (p. 1387) Gets the list of associated figures.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1458 of ANSYS, Inc. and its subsidiaries and affiliates.
Volume

(Inherited from Result (p. 1383).)


Property Frequency (p. 1462) Gets or sets the Frequency.
Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1462) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1459
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1462) Gets or sets the PhaseIncrement.
Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1460 of ANSYS, Inc. and its subsidiaries and affiliates.
Volume

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1462) Gets or sets the SweepingPhase.
Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

Amplitude
Gets or sets the Amplitude.

Declaration Syntax
public bool Amplitude { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1461
Ansys.ACT.Automation.Mechanical.Results Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Frequency
Gets or sets the Frequency.

Declaration Syntax
public Quantity Frequency { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

PhaseIncrement
Gets or sets the PhaseIncrement.

Declaration Syntax
public Quantity PhaseIncrement { set;get; }

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1462 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults

Table 458: Members

AccelerationPhaseResponse (p. 1463) Defines a


AccelerationPhaseResponse.
DeformationPhaseResponse (p. 1467) Defines a
DeformationPhaseResponse.
ElasticStrainPhaseResponse (p. 1470) Defines a
ElasticStrainPhaseResponse.
StressPhaseResponse (p. 1474) Defines a StressPhaseResponse.
VelocityPhaseResponse (p. 1477) Defines a
VelocityPhaseResponse.

AccelerationPhaseResponse
Defines a AccelerationPhaseResponse.

Declaration Syntax
public class AccelerationPhaseResponse : ResultChart

Table 459: Members

Property AccelerationType (p. 1400) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1398).)


Property BoundaryCondition (p. 1400) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1398).)


Property ChartDimensions (p. 1400) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1398).)


Property ChartViewingStyle (p. 1401) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1398).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1463
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property Children (p. 1401) Gets the list of children.

(Inherited from ResultChart (p. 1398).)


Property Comments (p. 1401) Gets the list of associated comments.

(Inherited from ResultChart (p. 1398).)


Property ContactRegion (p. 1466) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 1401) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1398).)


Property CurvesAppearanceDisplay (p. 1401) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1398).)


Property CutFrequency (p. 1401) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1398).)


Property DataModelObjectCategory (p. 1466) Gets the current DataModelObject's category.
Property DeformationType (p. 1402) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1398).)


Property DpfEvaluation (p. 1402) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1398).)


Property Duration (p. 1402) Gets or sets the Duration.

(Inherited from ResultChart (p. 1398).)


Property EnhancedTracking (p. 1402) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1398).)


Property FilterMaximum (p. 1402) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1398).)


Property FilterMinimum (p. 1403) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1398).)


Property FilterType (p. 1403) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1398).)


Property FrequencyAtMaximumAmplitude (p. 1403)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property GeometrySelectionString (p. 1403) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1398).)


Property Images (p. 1403) Gets the list of associated images.

(Inherited from ResultChart (p. 1398).)


Property ImaginaryAtMaximumAmplitude (p. 1403)Gets the ImaginaryAtMaximumAmplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1464 of ANSYS, Inc. and its subsidiaries and affiliates.
AccelerationPhaseResponse

(Inherited from ResultChart (p. 1398).)


Property InternalObject (p. 1467) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1404) Gets the IsSolved.

(Inherited from ResultChart (p. 1398).)


Property LoadStepNumber (p. 1404) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1398).)


Property Location (p. 1404) Gets or sets the Location.

(Inherited from ResultChart (p. 1398).)


Property Maximum (p. 1404) Gets the Maximum.

(Inherited from ResultChart (p. 1398).)


Property MaximumAmplitude (p. 1404) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property MaximumFrequency (p. 1405) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1398).)


Property Minimum (p. 1405) Gets the Minimum.

(Inherited from ResultChart (p. 1398).)


Property MinimumFrequency (p. 1405) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1398).)


Property NamedSelections (p. 1405) Gets or sets the NamedSelections.

(Inherited from ResultChart (p. 1398).)


Property NormalOrientation (p. 1405) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1398).)


Property PhaseAngle (p. 1405) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1398).)


Property RealAtMaximumAmplitude (p. 1406) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property ReportedFrequency (p. 1406) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1398).)


Property RequestedFrequency (p. 1406) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1398).)


Property ResultChartType (p. 1406) Gets the ResultChartType.

(Inherited from ResultChart (p. 1398).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1465
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property RPMSelection (p. 1406) Gets or sets the RPM Selection value at which the
results are evaluated.

(Inherited from ResultChart (p. 1398).)


Property SectorNumber (p. 1406) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1398).)


Property ShearOrientation (p. 1407) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1398).)


Property SpatialResolution (p. 1407) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1398).)


Property Spring (p. 1407) Gets or sets the Spring.

(Inherited from ResultChart (p. 1398).)


Property StressStrainType (p. 1407) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1398).)


Property Suppressed (p. 1407) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1398).)


Property TimeHistoryDisplay (p. 1407) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1398).)


Property UseParentFrequencyRange (p. 1408) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1398).)


Property VelocityType (p. 1408) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1398).)


Property XAxisValues (p. 1408) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1398).)

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1466 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationPhaseResponse

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

DeformationPhaseResponse
Defines a DeformationPhaseResponse.

Declaration Syntax
public class DeformationPhaseResponse : ResultChart

Table 460: Members

Property AccelerationType (p. 1400) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1398).)


Property BoundaryCondition (p. 1400) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1398).)


Property ChartDimensions (p. 1400) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1398).)


Property ChartViewingStyle (p. 1401) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1398).)


Property Children (p. 1401) Gets the list of children.

(Inherited from ResultChart (p. 1398).)


Property Comments (p. 1401) Gets the list of associated comments.

(Inherited from ResultChart (p. 1398).)


Property CoordinateSystem (p. 1401) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1398).)


Property CurvesAppearanceDisplay (p. 1401) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1398).)


Property CutFrequency (p. 1401) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1398).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1467
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property DataModelObjectCategory (p. 1470) Gets the current DataModelObject's category.


Property DeformationType (p. 1402) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1398).)


Property DpfEvaluation (p. 1402) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1398).)


Property Duration (p. 1402) Gets or sets the Duration.

(Inherited from ResultChart (p. 1398).)


Property EnhancedTracking (p. 1402) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1398).)


Property FilterMaximum (p. 1402) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1398).)


Property FilterMinimum (p. 1403) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1398).)


Property FilterType (p. 1403) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1398).)


Property FrequencyAtMaximumAmplitude (p. 1403)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property GeometrySelectionString (p. 1403) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1398).)


Property Images (p. 1403) Gets the list of associated images.

(Inherited from ResultChart (p. 1398).)


Property ImaginaryAtMaximumAmplitude (p. 1403)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property InternalObject (p. 1470) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1404) Gets the IsSolved.

(Inherited from ResultChart (p. 1398).)


Property LoadStepNumber (p. 1404) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1398).)


Property Location (p. 1404) Gets or sets the Location.

(Inherited from ResultChart (p. 1398).)


Property Maximum (p. 1404) Gets the Maximum.

(Inherited from ResultChart (p. 1398).)


Property MaximumAmplitude (p. 1404) Gets the MaximumAmplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1468 of ANSYS, Inc. and its subsidiaries and affiliates.
DeformationPhaseResponse

(Inherited from ResultChart (p. 1398).)


Property MaximumFrequency (p. 1405) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1398).)


Property Minimum (p. 1405) Gets the Minimum.

(Inherited from ResultChart (p. 1398).)


Property MinimumFrequency (p. 1405) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1398).)


Property NamedSelections (p. 1405) Gets or sets the NamedSelections.

(Inherited from ResultChart (p. 1398).)


Property NormalOrientation (p. 1405) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1398).)


Property PhaseAngle (p. 1405) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1398).)


Property RealAtMaximumAmplitude (p. 1406) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property ReportedFrequency (p. 1406) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1398).)


Property RequestedFrequency (p. 1406) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1398).)


Property ResultChartType (p. 1406) Gets the ResultChartType.

(Inherited from ResultChart (p. 1398).)


Property RPMSelection (p. 1406) Gets or sets the RPM Selection value at which the
results are evaluated.

(Inherited from ResultChart (p. 1398).)


Property SectorNumber (p. 1406) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1398).)


Property ShearOrientation (p. 1407) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1398).)


Property SpatialResolution (p. 1407) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1398).)


Property Spring (p. 1407) Gets or sets the Spring.

(Inherited from ResultChart (p. 1398).)


Property StressStrainType (p. 1407) Gets or sets the StressStrainType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1469
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 1398).)


Property Suppressed (p. 1407) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1398).)


Property TimeHistoryDisplay (p. 1407) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1398).)


Property UseParentFrequencyRange (p. 1408) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1398).)


Property VelocityType (p. 1408) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1398).)


Property XAxisValues (p. 1408) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1398).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

ElasticStrainPhaseResponse
Defines a ElasticStrainPhaseResponse.

Declaration Syntax
public class ElasticStrainPhaseResponse : ResultChart

Table 461: Members

Property AccelerationType (p. 1400) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1398).)


Property BoundaryCondition (p. 1400) Gets or sets the BoundaryCondition.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1470 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainPhaseResponse

(Inherited from ResultChart (p. 1398).)


Property ChartDimensions (p. 1400) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1398).)


Property ChartViewingStyle (p. 1401) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1398).)


Property Children (p. 1401) Gets the list of children.

(Inherited from ResultChart (p. 1398).)


Property Comments (p. 1401) Gets the list of associated comments.

(Inherited from ResultChart (p. 1398).)


Property ContactRegion (p. 1473) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 1401) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1398).)


Property CurvesAppearanceDisplay (p. 1401) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1398).)


Property CutFrequency (p. 1401) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1398).)


Property DataModelObjectCategory (p. 1474) Gets the current DataModelObject's category.
Property DeformationType (p. 1402) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1398).)


Property DpfEvaluation (p. 1402) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1398).)


Property Duration (p. 1402) Gets or sets the Duration.

(Inherited from ResultChart (p. 1398).)


Property EnhancedTracking (p. 1402) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1398).)


Property FilterMaximum (p. 1402) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1398).)


Property FilterMinimum (p. 1403) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1398).)


Property FilterType (p. 1403) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1398).)


Property FrequencyAtMaximumAmplitude (p. 1403)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1471
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property GeometrySelectionString (p. 1403) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1398).)


Property Images (p. 1403) Gets the list of associated images.

(Inherited from ResultChart (p. 1398).)


Property ImaginaryAtMaximumAmplitude (p. 1403)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property InternalObject (p. 1474) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1404) Gets the IsSolved.

(Inherited from ResultChart (p. 1398).)


Property LoadStepNumber (p. 1404) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1398).)


Property Location (p. 1404) Gets or sets the Location.

(Inherited from ResultChart (p. 1398).)


Property Maximum (p. 1404) Gets the Maximum.

(Inherited from ResultChart (p. 1398).)


Property MaximumAmplitude (p. 1404) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property MaximumFrequency (p. 1405) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1398).)


Property Minimum (p. 1405) Gets the Minimum.

(Inherited from ResultChart (p. 1398).)


Property MinimumFrequency (p. 1405) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1398).)


Property NamedSelections (p. 1405) Gets or sets the NamedSelections.

(Inherited from ResultChart (p. 1398).)


Property NormalOrientation (p. 1405) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1398).)


Property PhaseAngle (p. 1405) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1398).)


Property RealAtMaximumAmplitude (p. 1406) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property ReportedFrequency (p. 1406) Gets the ReportedFrequency.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1472 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainPhaseResponse

(Inherited from ResultChart (p. 1398).)


Property RequestedFrequency (p. 1406) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1398).)


Property ResultChartType (p. 1406) Gets the ResultChartType.

(Inherited from ResultChart (p. 1398).)


Property RPMSelection (p. 1406) Gets or sets the RPM Selection value at which the
results are evaluated.

(Inherited from ResultChart (p. 1398).)


Property SectorNumber (p. 1406) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1398).)


Property ShearOrientation (p. 1407) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1398).)


Property SpatialResolution (p. 1407) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1398).)


Property Spring (p. 1407) Gets or sets the Spring.

(Inherited from ResultChart (p. 1398).)


Property StressStrainType (p. 1407) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1398).)


Property Suppressed (p. 1407) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1398).)


Property TimeHistoryDisplay (p. 1407) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1398).)


Property UseParentFrequencyRange (p. 1408) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1398).)


Property VelocityType (p. 1408) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1398).)


Property XAxisValues (p. 1408) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1398).)

ContactRegion
Gets or sets the ContactRegion.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1473
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

StressPhaseResponse
Defines a StressPhaseResponse.

Declaration Syntax
public class StressPhaseResponse : ResultChart

Table 462: Members

Property AccelerationType (p. 1400) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1398).)


Property BoundaryCondition (p. 1400) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1398).)


Property ChartDimensions (p. 1400) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1398).)


Property ChartViewingStyle (p. 1401) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1398).)


Property Children (p. 1401) Gets the list of children.

(Inherited from ResultChart (p. 1398).)


Property Comments (p. 1401) Gets the list of associated comments.

(Inherited from ResultChart (p. 1398).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1474 of ANSYS, Inc. and its subsidiaries and affiliates.
StressPhaseResponse

Property CoordinateSystem (p. 1401) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1398).)


Property CurvesAppearanceDisplay (p. 1401) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1398).)


Property CutFrequency (p. 1401) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1398).)


Property DataModelObjectCategory (p. 1477) Gets the current DataModelObject's category.
Property DeformationType (p. 1402) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1398).)


Property DpfEvaluation (p. 1402) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1398).)


Property Duration (p. 1402) Gets or sets the Duration.

(Inherited from ResultChart (p. 1398).)


Property EnhancedTracking (p. 1402) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1398).)


Property FilterMaximum (p. 1402) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1398).)


Property FilterMinimum (p. 1403) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1398).)


Property FilterType (p. 1403) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1398).)


Property FrequencyAtMaximumAmplitude (p. 1403)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property GeometrySelectionString (p. 1403) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1398).)


Property Images (p. 1403) Gets the list of associated images.

(Inherited from ResultChart (p. 1398).)


Property ImaginaryAtMaximumAmplitude (p. 1403)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property InternalObject (p. 1477) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1404) Gets the IsSolved.

(Inherited from ResultChart (p. 1398).)


Property LoadStepNumber (p. 1404) Gets or sets the LoadStepNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1475
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 1398).)


Property Location (p. 1404) Gets or sets the Location.

(Inherited from ResultChart (p. 1398).)


Property Maximum (p. 1404) Gets the Maximum.

(Inherited from ResultChart (p. 1398).)


Property MaximumAmplitude (p. 1404) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property MaximumFrequency (p. 1405) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1398).)


Property Minimum (p. 1405) Gets the Minimum.

(Inherited from ResultChart (p. 1398).)


Property MinimumFrequency (p. 1405) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1398).)


Property NamedSelections (p. 1405) Gets or sets the NamedSelections.

(Inherited from ResultChart (p. 1398).)


Property NormalOrientation (p. 1405) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1398).)


Property PhaseAngle (p. 1405) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1398).)


Property RealAtMaximumAmplitude (p. 1406) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property ReportedFrequency (p. 1406) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1398).)


Property RequestedFrequency (p. 1406) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1398).)


Property ResultChartType (p. 1406) Gets the ResultChartType.

(Inherited from ResultChart (p. 1398).)


Property RPMSelection (p. 1406) Gets or sets the RPM Selection value at which the
results are evaluated.

(Inherited from ResultChart (p. 1398).)


Property SectorNumber (p. 1406) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1398).)


Property ShearOrientation (p. 1407) Gets or sets the ShearOrientation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1476 of ANSYS, Inc. and its subsidiaries and affiliates.
VelocityPhaseResponse

(Inherited from ResultChart (p. 1398).)


Property SpatialResolution (p. 1407) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1398).)


Property Spring (p. 1407) Gets or sets the Spring.

(Inherited from ResultChart (p. 1398).)


Property StressStrainType (p. 1407) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1398).)


Property Suppressed (p. 1407) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1398).)


Property TimeHistoryDisplay (p. 1407) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1398).)


Property UseParentFrequencyRange (p. 1408) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1398).)


Property VelocityType (p. 1408) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1398).)


Property XAxisValues (p. 1408) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1398).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

VelocityPhaseResponse
Defines a VelocityPhaseResponse.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1477
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Declaration Syntax
public class VelocityPhaseResponse : ResultChart

Table 463: Members

Property AccelerationType (p. 1400) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1398).)


Property BoundaryCondition (p. 1400) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1398).)


Property ChartDimensions (p. 1400) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1398).)


Property ChartViewingStyle (p. 1401) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1398).)


Property Children (p. 1401) Gets the list of children.

(Inherited from ResultChart (p. 1398).)


Property Comments (p. 1401) Gets the list of associated comments.

(Inherited from ResultChart (p. 1398).)


Property ContactRegion (p. 1481) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 1401) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1398).)


Property CurvesAppearanceDisplay (p. 1401) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1398).)


Property CutFrequency (p. 1401) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1398).)


Property DataModelObjectCategory (p. 1481) Gets the current DataModelObject's category.
Property DeformationType (p. 1402) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1398).)


Property DpfEvaluation (p. 1402) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1398).)


Property Duration (p. 1402) Gets or sets the Duration.

(Inherited from ResultChart (p. 1398).)


Property EnhancedTracking (p. 1402) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1398).)


Property FilterMaximum (p. 1402) Gets the FilterMaximum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1478 of ANSYS, Inc. and its subsidiaries and affiliates.
VelocityPhaseResponse

(Inherited from ResultChart (p. 1398).)


Property FilterMinimum (p. 1403) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1398).)


Property FilterType (p. 1403) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1398).)


Property FrequencyAtMaximumAmplitude (p. 1403)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property GeometrySelectionString (p. 1403) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1398).)


Property Images (p. 1403) Gets the list of associated images.

(Inherited from ResultChart (p. 1398).)


Property ImaginaryAtMaximumAmplitude (p. 1403)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property InternalObject (p. 1481) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1404) Gets the IsSolved.

(Inherited from ResultChart (p. 1398).)


Property LoadStepNumber (p. 1404) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1398).)


Property Location (p. 1404) Gets or sets the Location.

(Inherited from ResultChart (p. 1398).)


Property Maximum (p. 1404) Gets the Maximum.

(Inherited from ResultChart (p. 1398).)


Property MaximumAmplitude (p. 1404) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property MaximumFrequency (p. 1405) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1398).)


Property Minimum (p. 1405) Gets the Minimum.

(Inherited from ResultChart (p. 1398).)


Property MinimumFrequency (p. 1405) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1398).)


Property NamedSelections (p. 1405) Gets or sets the NamedSelections.

(Inherited from ResultChart (p. 1398).)


Property NormalOrientation (p. 1405) Gets or sets the NormalOrientation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1479
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 1398).)


Property PhaseAngle (p. 1405) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1398).)


Property RealAtMaximumAmplitude (p. 1406) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1398).)


Property ReportedFrequency (p. 1406) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1398).)


Property RequestedFrequency (p. 1406) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1398).)


Property ResultChartType (p. 1406) Gets the ResultChartType.

(Inherited from ResultChart (p. 1398).)


Property RPMSelection (p. 1406) Gets or sets the RPM Selection value at which the
results are evaluated.

(Inherited from ResultChart (p. 1398).)


Property SectorNumber (p. 1406) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1398).)


Property ShearOrientation (p. 1407) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1398).)


Property SpatialResolution (p. 1407) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1398).)


Property Spring (p. 1407) Gets or sets the Spring.

(Inherited from ResultChart (p. 1398).)


Property StressStrainType (p. 1407) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1398).)


Property Suppressed (p. 1407) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1398).)


Property TimeHistoryDisplay (p. 1407) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1398).)


Property UseParentFrequencyRange (p. 1408) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1398).)


Property VelocityType (p. 1408) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1398).)


Property XAxisValues (p. 1408) Gets or sets the XAxisValues.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1480 of ANSYS, Inc. and its subsidiaries and affiliates.
VelocityPhaseResponse

(Inherited from ResultChart (p. 1398).)

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1481
Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1482 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.StrainResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.StrainResults

Table 464: Members

AccumulatedEquivalentPlasticStrain (p. 1483) Defines a


AccumulatedEquivalentPlasticStrain.
DirectionalThermalStrain (p. 1489) Defines a DirectionalThermalStrain.
ElasticStrainIntensity (p. 1494) Defines a ElasticStrainIntensity.
EquivalentCreepStrain (p. 1499) Defines a EquivalentCreepStrain.
EquivalentCreepStrainRST (p. 1505) Defines a EquivalentCreepStrainRST.
EquivalentElasticStrain (p. 1510) Defines a EquivalentElasticStrain.
EquivalentElasticStrainRST (p. 1515) Defines a EquivalentElasticStrainRST.
EquivalentPlasticStrain (p. 1520) Defines a EquivalentPlasticStrain.
EquivalentPlasticStrainRST (p. 1526) Defines a EquivalentPlasticStrainRST.
EquivalentTotalStrain (p. 1531) Defines a EquivalentTotalStrain.
MaximumPrincipalElasticStrain (p. 1536) Defines a MaximumPrincipalElasticStrain.
MaximumPrincipalThermalStrain (p. 1542) Defines a
MaximumPrincipalThermalStrain.
MaximumShearElasticStrain (p. 1547) Defines a MaximumShearElasticStrain.
MiddlePrincipalElasticStrain (p. 1552) Defines a MiddlePrincipalElasticStrain.
MiddlePrincipalThermalStrain (p. 1558) Defines a MiddlePrincipalThermalStrain.
MinimumPrincipalElasticStrain (p. 1563) Defines a MinimumPrincipalElasticStrain.
NormalElasticStrain (p. 1568) Defines a NormalElasticStrain.
ShearElasticStrain (p. 1574) Defines a ShearElasticStrain.
StrainResult (p. 1580) Defines a StrainResult.
VectorPrincipalElasticStrain (p. 1587) Defines a VectorPrincipalElasticStrain.

AccumulatedEquivalentPlasticStrain
Defines a AccumulatedEquivalentPlasticStrain.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1483
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class AccumulatedEquivalentPlasticStrain : StrainResult

Table 465: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1488) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1484 of ANSYS, Inc. and its subsidiaries and affiliates.
AccumulatedEquivalentPlasticStrain

Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1488) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1485
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1486 of ANSYS, Inc. and its subsidiaries and affiliates.
AccumulatedEquivalentPlasticStrain

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1487
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1488 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalStrain

Declaration Syntax
public IDSResultAuto InternalObject { get; }

DirectionalThermalStrain
Defines a DirectionalThermalStrain.

Declaration Syntax
public class DirectionalThermalStrain : StrainResult

Table 466: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1489
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1494) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1494) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1490 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalStrain

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1491
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property NormalOrientation (p. 1494) Gets or sets the NormalOrientation.
Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1492 of ANSYS, Inc. and its subsidiaries and affiliates.
DirectionalThermalStrain

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1493
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

ElasticStrainIntensity
Defines a ElasticStrainIntensity.

Declaration Syntax
public class ElasticStrainIntensity : StrainResult

Table 467: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1494 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainIntensity

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1499) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1495
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1499) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1496 of ANSYS, Inc. and its subsidiaries and affiliates.
ElasticStrainIntensity

Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1497
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1498 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrain

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EquivalentCreepStrain
Defines a EquivalentCreepStrain.

Declaration Syntax
public class EquivalentCreepStrain : StrainResult

Table 468: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1499
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1504) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1500 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrain

Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1504) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1501
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1502 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrain

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1503
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1504 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrainRST

EquivalentCreepStrainRST
Defines a EquivalentCreepStrainRST.

Declaration Syntax
public class EquivalentCreepStrainRST : StrainResult

Table 469: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1505
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property DataModelObjectCategory (p. 1509) Gets the current DataModelObject's


category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1510) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1506 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrainRST

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1507
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1508 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentCreepStrainRST

Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1509
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EquivalentElasticStrain
Defines a EquivalentElasticStrain.

Declaration Syntax
public class EquivalentElasticStrain : StrainResult

Table 470: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1510 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrain

Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1515) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1511
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property InternalObject (p. 1515) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1512 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrain

Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1513
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1514 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrainRST

Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EquivalentElasticStrainRST
Defines a EquivalentElasticStrainRST.

Declaration Syntax
public class EquivalentElasticStrainRST : StrainResult

Table 471: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1515
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1520) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1516 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrainRST

Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1520) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1517
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1518 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentElasticStrainRST

Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1519
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EquivalentPlasticStrain
Defines a EquivalentPlasticStrain.

Declaration Syntax
public class EquivalentPlasticStrain : StrainResult

Table 472: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1520 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrain

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1525) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1521
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1525) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1522 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrain

Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1523
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1524 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrain

Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1525
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

EquivalentPlasticStrainRST
Defines a EquivalentPlasticStrainRST.

Declaration Syntax
public class EquivalentPlasticStrainRST : StrainResult

Table 473: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1526 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrainRST

Property DataModelObjectCategory (p. 1530) Gets the current DataModelObject's


category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1531) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1527
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1528 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentPlasticStrainRST

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1529
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1530 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentTotalStrain

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

EquivalentTotalStrain
Defines a EquivalentTotalStrain.

Declaration Syntax
public class EquivalentTotalStrain : StrainResult

Table 474: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1531
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.


Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1536) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1532 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentTotalStrain

Property InternalObject (p. 1536) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1533
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1534 of ANSYS, Inc. and its subsidiaries and affiliates.
EquivalentTotalStrain

Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1535
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MaximumPrincipalElasticStrain
Defines a MaximumPrincipalElasticStrain.

Declaration Syntax
public class MaximumPrincipalElasticStrain : StrainResult

Table 475: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1536 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalElasticStrain

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1541) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1537
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1541) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property Layer (p. 1541) Gets or sets the Layer.
Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1538 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalElasticStrain

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property NormalOrientation (p. 1542) Gets or sets the NormalOrientation.
Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1539
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1540 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalElasticStrain

Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Layer
Gets or sets the Layer.

Declaration Syntax
public int Layer { set;get; }

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1541
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

MaximumPrincipalThermalStrain
Defines a MaximumPrincipalThermalStrain.

Declaration Syntax
public class MaximumPrincipalThermalStrain : StrainResult

Table 476: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1542 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalThermalStrain

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1547) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1547) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1543
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1544 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumPrincipalThermalStrain

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1545
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property SolutionCombinationDriver (p. 1392) Gets or sets the


SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1546 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumShearElasticStrain

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MaximumShearElasticStrain
Defines a MaximumShearElasticStrain.

Declaration Syntax
public class MaximumShearElasticStrain : StrainResult

Table 477: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1547
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1552) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1548 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumShearElasticStrain

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1552) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1549
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1550 of ANSYS, Inc. and its subsidiaries and affiliates.
MaximumShearElasticStrain

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property ShearOrientation (p. 1552) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1551
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

ShearOrientation
Gets or sets the ShearOrientation.

Declaration Syntax
public ShearOrientationType ShearOrientation { set;get; }

MiddlePrincipalElasticStrain
Defines a MiddlePrincipalElasticStrain.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1552 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalElasticStrain

Declaration Syntax
public class MiddlePrincipalElasticStrain : StrainResult

Table 478: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1557) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1553
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1557) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1554 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalElasticStrain

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1555
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1556 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalElasticStrain

Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1557
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MiddlePrincipalThermalStrain
Defines a MiddlePrincipalThermalStrain.

Declaration Syntax
public class MiddlePrincipalThermalStrain : StrainResult

Table 479: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1558 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalThermalStrain

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1563) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1563) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1559
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1560 of ANSYS, Inc. and its subsidiaries and affiliates.
MiddlePrincipalThermalStrain

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1561
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1562 of ANSYS, Inc. and its subsidiaries and affiliates.
MinimumPrincipalElasticStrain

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

MinimumPrincipalElasticStrain
Defines a MinimumPrincipalElasticStrain.

Declaration Syntax
public class MinimumPrincipalElasticStrain : StrainResult

Table 480: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1563
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1568) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1564 of ANSYS, Inc. and its subsidiaries and affiliates.
MinimumPrincipalElasticStrain

Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1568) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1565
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1566 of ANSYS, Inc. and its subsidiaries and affiliates.
MinimumPrincipalElasticStrain

Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1567
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalElasticStrain
Defines a NormalElasticStrain.

Declaration Syntax
public class NormalElasticStrain : StrainResult

Table 481: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1568 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalElasticStrain

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1573) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1569
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1573) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1570 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalElasticStrain

Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property NormalOrientation (p. 1573) Gets or sets the NormalOrientation.
Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1571
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScaleFactor (p. 1574) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1574) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1572 of ANSYS, Inc. and its subsidiaries and affiliates.
NormalElasticStrain

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalOrientation
Gets or sets the NormalOrientation.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1573
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public ScaleFactorType ScaleFactor { set;get; }

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Declaration Syntax
public double ScaleFactorValue { set;get; }

ShearElasticStrain
Defines a ShearElasticStrain.

Declaration Syntax
public class ShearElasticStrain : StrainResult

Table 482: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1574 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearElasticStrain

Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1579) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1575
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1579) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1576 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearElasticStrain

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.

(Inherited from StrainResult (p. 1580).)


Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1580).)


Property Plies (p. 1586) No details are provided for this entry.

(Inherited from StrainResult (p. 1580).)


Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1580).)


Property Position (p. 1586) Gets or sets the Position.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1577
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1580).)


Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScaleFactor (p. 1579) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1579) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property ShearOrientation (p. 1580) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1580).)


Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1580).)


Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1580).)


Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1578 of ANSYS, Inc. and its subsidiaries and affiliates.
ShearElasticStrain

Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public ScaleFactorType ScaleFactor { set;get; }

ScaleFactorValue
Gets or sets the ScaleFactorValue.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1579
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public double ScaleFactorValue { set;get; }

ShearOrientation
Gets or sets the ShearOrientation.

Declaration Syntax
public ShearOrientationType ShearOrientation { set;get; }

StrainResult
Defines a StrainResult.

Declaration Syntax
public abstract class StrainResult : Result

Table 483: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.
Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1580 of ANSYS, Inc. and its subsidiaries and affiliates.
StrainResult

Fiber Coordinate System for a result that


is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.
Property DataModelObjectCategory (p. 1585) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)


Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.
Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.
Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.
Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1585) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1581
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.
Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.
Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMinimumValues (p. 1389)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMaximumValues (p. 1389)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property LoadStepForMinimumOfMinimumValues (p. 1389)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property LoadStepNumber (p. 1390) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1383).)


Property Location (p. 1390) Gets or sets the Location.

(Inherited from Result (p. 1383).)


Property Maximum (p. 1390) Gets the Maximum.

(Inherited from Result (p. 1383).)


Property MaximumOccursOn (p. 1390) Gets the MaximumOccursOn.

(Inherited from Result (p. 1383).)


Property MaximumOfMaximumOverTime (p. 1390) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1383).)


Property MaximumOfMinimumOverTime (p. 1390) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Minimum (p. 1391) Gets the Minimum.

(Inherited from Result (p. 1383).)


Property MinimumOccursOn (p. 1391) Gets the MinimumOccursOn.

(Inherited from Result (p. 1383).)


Property MinimumOfMaximumOverTime (p. 1391) Gets the MinimumOfMaximumOverTime.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1582 of ANSYS, Inc. and its subsidiaries and affiliates.
StrainResult

(Inherited from Result (p. 1383).)


Property MinimumOfMinimumOverTime (p. 1391) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1383).)


Property Mode (p. 1586) Gets or sets the Mode.
Property NamedSelections (p. 1391) Gets or sets the NamedSelections.

(Inherited from Result (p. 1383).)


Property Path (p. 1391) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property PhaseIncrement (p. 1586) Gets or sets the PhaseIncrement.
Property Plies (p. 1586) No details are provided for this entry.
Property PlotData (p. 1392) Gets the result table.

(Inherited from Result (p. 1383).)


Property Ply (p. 1586) Gets or sets the Ply selection.
Property Position (p. 1586) Gets or sets the Position.
Property ReportedFrequency (p. 1587) Gets the ReportedFrequency.
Property RPMSelection (p. 1392) Gets or sets the RPM Selection value at
which the results are evaluated.

(Inherited from Result (p. 1383).)


Property ScopingMethod (p. 1392) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1383).)


Property SetNumber (p. 1392) Gets or sets the Set Number.

(Inherited from Result (p. 1383).)


Property SolutionCombinationDriver (p. 1392) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1383).)


Property SolverComponentIDs (p. 1392) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1383).)


Property StressStrainType (p. 1587) Gets or sets the StressStrainType.
Property SubScopeBy (p. 1587) Gets or sets the SubScopeBy.
Property Substep (p. 1393) Gets the Substep.

(Inherited from Result (p. 1383).)


Property Suppressed (p. 1393) Gets or sets the Suppressed.

(Inherited from Result (p. 1383).)


Property Surface (p. 1393) No details are provided for this entry.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1583
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1383).)


Property SurfaceCoating (p. 1393) No details are provided for this entry.

(Inherited from Result (p. 1383).)


Property SweepingPhase (p. 1587) Gets or sets the SweepingPhase.
Property Time (p. 1393) Gets the Time.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMaximumValues (p. 1393) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMaximumOfMinimumValues (p. 1394) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMaximumValues (p. 1394) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1383).)


Property TimeForMinimumOfMinimumValues (p. 1394) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1383).)


Property Total (p. 1394) Gets the Total.

(Inherited from Result (p. 1383).)

Amplitude
Gets or sets the Amplitude.

Declaration Syntax
public bool Amplitude { set;get; }

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Declaration Syntax
public bool AverageAcrossBodies { set;get; }

CyclicMode
Gets or sets the CyclicMode.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1584 of ANSYS, Inc. and its subsidiaries and affiliates.
StrainResult

Declaration Syntax
public uint CyclicMode { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

EnvironmentSelection
Gets or sets the EnvironmentSelection.

Declaration Syntax
public Analysis EnvironmentSelection { set;get; }

Frequency
Gets or sets the Frequency.

Declaration Syntax
public Quantity Frequency { set;get; }

HarmonicIndex
Gets or sets the HarmonicIndex.

Declaration Syntax
public uint HarmonicIndex { set;get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

IterationStep
Gets or sets the IterationStep.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1585
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public int IterationStep { set;get; }

LoadMultiplier
Gets the LoadMultiplier.

Declaration Syntax
public double LoadMultiplier { get; }

Mode
Gets or sets the Mode.

Declaration Syntax
public uint Mode { set;get; }

PhaseIncrement
Gets or sets the PhaseIncrement.

Declaration Syntax
public Quantity PhaseIncrement { set;get; }

Plies
No details are provided for this entry.

Declaration Syntax
public IEnumerable<ImportedPliesCollection> Plies { set;get; }

Ply
Gets or sets the Ply selection.

Declaration Syntax
public IEnumerable<AnalysisPly> Ply { set;get; }

Position
Gets or sets the Position.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1586 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorPrincipalElasticStrain

Declaration Syntax
public ShellFaceType Position { set;get; }

ReportedFrequency
Gets the ReportedFrequency.

Declaration Syntax
public Quantity ReportedFrequency { get; }

StressStrainType
Gets or sets the StressStrainType.

Declaration Syntax
public StressStrainType StressStrainType { set;get; }

SubScopeBy
Gets or sets the SubScopeBy.

Declaration Syntax
public SubScopingDefineByType SubScopeBy { set;get; }

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

VectorPrincipalElasticStrain
Defines a VectorPrincipalElasticStrain.

Declaration Syntax
public class VectorPrincipalElasticStrain : StrainResult

Table 484: Members

Property Amplitude (p. 1584) Gets or sets the Amplitude.

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1587
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from StrainResult (p. 1580).)


Property Average (p. 1385) Gets the Average.

(Inherited from Result (p. 1383).)


Property AverageAcrossBodies (p. 1584) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1580).)


Property By (p. 1385) Gets or sets the By.

(Inherited from Result (p. 1383).)


Property CalculateTimeHistory (p. 1385) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1383).)


Property Children (p. 1386) Gets the list of children.

(Inherited from Result (p. 1383).)


Property CombinationNumber (p. 1386) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1383).)


Property Comments (p. 1386) Gets the list of associated comments.

(Inherited from Result (p. 1383).)


Property CoordinateSystem (p. 1386) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if
applicable). Accepts/Returns None for
Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1383).)


Property CrackFrontNumber (p. 1386) Gets or sets the CrackFrontNumber.

(Inherited from Result (p. 1383).)


Property CyclicMode (p. 1584) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1580).)


Property DataModelObjectCategory (p. 1592) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1387) Gets or sets the DisplayOption.

(Inherited from Result (p. 1383).)


Property DisplayTime (p. 1387) Gets or sets the DisplayTime.

(Inherited from Result (p. 1383).)


Property DpfEvaluation (p. 1387) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1383).)

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1588 of ANSYS, Inc. and its subsidiaries and affiliates.
VectorPrincipalElasticStrain

Property EnvironmentSelection (p. 1585) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1580).)


Property Figures (p. 1387) Gets the list of associated figures.

(Inherited from Result (p. 1383).)


Property Frequency (p. 1585) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1580).)


Property GlobalIDs (p. 1387) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1383).)


Property GraphControlsXAxis (p. 1388) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1383).)


Property HarmonicIndex (p. 1585) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1580).)


Property Identifier (p. 1388) Gets or sets the Identifier.

(Inherited from Result (p. 1383).)


Property Images (p. 1388) Gets the list of associated images.

(Inherited from Result (p. 1383).)


Property InternalObject (p. 1592) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1388) Gets the IsSolved.

(Inherited from Result (p. 1383).)


Property ItemType (p. 1388) Gets or sets the ItemType.

(Inherited from Result (p. 1383).)


Property IterationNumber (p. 1389) Gets the IterationNumber.

(Inherited from Result (p. 1383).)


Property IterationStep (p. 1585) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1580).)


Property LoadMultiplier (p. 1586) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1580).)


Property LoadStep (p. 1389) Gets the LoadStep.

(Inherited from Result (p. 1383).)


Property LoadStepForMaximumOfMaximumValues (p. 1389)Get the Load Step for the maximum of

You might also like