ACT API Reference Guide

ANSYS, Inc. Release 2022 R2

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

© 2022 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.ACT.DesignModeler.Primitives.Sheet Namespace ................................................................... 11
Cylinder .......................................................................................................................................... 11
Cylinder(GeometryBuilder, IEnumerable<double>, IEnumerable<double>, double) .................... 11
Center ...................................................................................................................................... 12
Direction .................................................................................................................................. 12
Radius ...................................................................................................................................... 12
Generate() ................................................................................................................................ 12
Ansys.ACT.Mechanical Namespace .................................................................................................... 13
Transaction ..................................................................................................................................... 13
UnitsHelper .................................................................................................................................... 13
ConvertMechanicalUnitToCoreUnit(string, string) ...................................................................... 13
GetValidQuantityNamesAndUnits() ........................................................................................... 14
Ansys.ACT.Mechanical.Fields Namespace .......................................................................................... 15
Field ............................................................................................................................................... 15
Inputs ...................................................................................................................................... 15
Name ....................................................................................................................................... 16
Output ..................................................................................................................................... 16
Range ............................................................................................................................................ 16
Maximum ................................................................................................................................. 16
Minimum ................................................................................................................................. 16
Variable .......................................................................................................................................... 17
DefinitionType .......................................................................................................................... 17
DiscreteValueCount .................................................................................................................. 18
DiscreteValues .......................................................................................................................... 18
Field ......................................................................................................................................... 18

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

Formula .................................................................................................................................... 18
Index ........................................................................................................................................ 18
IsInput ...................................................................................................................................... 19
IsOutput ................................................................................................................................... 19
MinMaxDiscreteValues .............................................................................................................. 19
Name ....................................................................................................................................... 19
QuantityName .......................................................................................................................... 19
Range ...................................................................................................................................... 19
Unit .......................................................................................................................................... 20
GetDiscreteValue(int) ................................................................................................................ 20
SetDiscreteValue(int, Quantity) .................................................................................................. 20
VariableDefinitionType ................................................................................................................... 20
Ansys.ACT.Mechanical.Fields.Adapters Namespace .......................................................................... 23
FieldAdapter ................................................................................................................................... 23
FieldAdapter(IDSBCInformation) ............................................................................................... 23
FieldProvider ............................................................................................................................ 24
ChangeFieldDefinitionType(AnsBCLVType, kEDDataType) .......................................................... 24
IDefinition ................................................................................................................................ 24
Adapt(IDSBCInformation) ................................................................................................... 25
Keywords ................................................................................................................................. 25
Constant ............................................................................................................................ 25
ConstantRamped ................................................................................................................ 25
Free .................................................................................................................................... 26
Function ............................................................................................................................. 26
Table .................................................................................................................................. 26
Get(kEDDataType) .............................................................................................................. 26
FieldAdapterManager ..................................................................................................................... 26
AdapterDefinitions ................................................................................................................... 27
RegisterNewAdapter(IDefinition) .............................................................................................. 27
UnregisterAdapter(int) .............................................................................................................. 27
Ansys.ACT.Mechanical.Utilities Namespace ....................................................................................... 29
GeometryImportPreferences ........................................................................................................... 29
AnalysisType ............................................................................................................................ 31
AttributeKey ............................................................................................................................. 31
CADAssociativity ...................................................................................................................... 31
Clean ........................................................................................................................................ 31
ComparePartsOnUpdate ........................................................................................................... 31
ComparePartsTolerance ............................................................................................................ 31
CoordinateSystemKey ............................................................................................................... 32
DecomposeDisjointGeometry ................................................................................................... 32
DoSmartUpdate ....................................................................................................................... 32
EnclosureSymmetryProcessing ................................................................................................. 32
FacetQuality ............................................................................................................................. 32
MixedImportResolution ............................................................................................................ 33
NamedSelectionKey ................................................................................................................. 33
ProcessAttributes ..................................................................................................................... 33
ProcessCoordinateSystems ....................................................................................................... 33
ProcessInstances ...................................................................................................................... 33
ProcessLines ............................................................................................................................. 33
ProcessMaterialProperties ......................................................................................................... 34
ProcessNamedSelections .......................................................................................................... 34

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

ProcessSolids ............................................................................................................................ 34
ProcessSurfaces ........................................................................................................................ 34
ProcessWorkPoints ................................................................................................................... 34
ReaderSaveFile ......................................................................................................................... 34
StitchTolerance ......................................................................................................................... 35
StitchType ................................................................................................................................ 35
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace ............................................. 37
ILinuxSettings ................................................................................................................................ 37
Active ....................................................................................................................................... 38
UserName ................................................................................................................................ 38
WorkingFolder .......................................................................................................................... 38
IQueueSettings ............................................................................................................................... 38
DCSPassword ........................................................................................................................... 38
DCSUrl ..................................................................................................................................... 39
DCSUsername .......................................................................................................................... 39
JobName .................................................................................................................................. 39
License ..................................................................................................................................... 39
Name ....................................................................................................................................... 39
SolutionExecutionTarget ........................................................................................................... 39
ISolveConfiguration ........................................................................................................................ 40
Default ..................................................................................................................................... 40
Name ....................................................................................................................................... 40
Settings .................................................................................................................................... 40
SolveProcessSettings ................................................................................................................ 41
SetAsDefault() .......................................................................................................................... 41
ISolveProcessSettings ..................................................................................................................... 41
AdditionalCommandLineArguments ......................................................................................... 42
CustomExecutablePath ............................................................................................................. 42
DistributeSolution .................................................................................................................... 42
GPUAccelerationDevice ............................................................................................................ 42
HybridParallel ........................................................................................................................... 42
LicenseQueuing ....................................................................................................................... 43
ManualLinuxSettings ................................................................................................................ 43
ManualSolverMemorySettings .................................................................................................. 43
MaxNumberOfCores ................................................................................................................. 43
NumberOfGPUDevices ............................................................................................................. 43
NumberOfProcesses ................................................................................................................. 43
SolveInSynchronousMode ........................................................................................................ 44
ThreadsPerProcess .................................................................................................................... 44
UserString ................................................................................................................................ 44
UseSharedLicense .................................................................................................................... 44
ISolverMemorySettings .................................................................................................................. 44
Active ....................................................................................................................................... 45
Database .................................................................................................................................. 45
Workspace ................................................................................................................................ 45
LinuxSettings ................................................................................................................................. 45
LinuxSettings() ......................................................................................................................... 45
Active ....................................................................................................................................... 46
UserName ................................................................................................................................ 46
WorkingFolder .......................................................................................................................... 46
QueueSettings ............................................................................................................................... 46

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

QueueSettings() ....................................................................................................................... 46
JobName .................................................................................................................................. 47
License ..................................................................................................................................... 47
Name ....................................................................................................................................... 47
RSMQueue ..................................................................................................................................... 47
HPCConfiguration ..................................................................................................................... 47
HPCQueue ................................................................................................................................ 48
HPCType .................................................................................................................................. 48
Name ....................................................................................................................................... 48
SolveConfiguration ......................................................................................................................... 48
SolveConfiguration() ................................................................................................................. 49
SolveConfiguration(string) ........................................................................................................ 49
Default ..................................................................................................................................... 49
Name ....................................................................................................................................... 49
Settings .................................................................................................................................... 49
SolveProcessSettings ................................................................................................................ 50
SetAsDefault() .......................................................................................................................... 50
SolveProcessSettings ...................................................................................................................... 50
SolveProcessSettings() .............................................................................................................. 51
AdditionalCommandLineArguments ......................................................................................... 51
CustomExecutablePath ............................................................................................................. 51
DistributeSolution .................................................................................................................... 51
GPUAccelerationDevice ............................................................................................................ 51
HybridParallel ........................................................................................................................... 51
LicenseQueuing ....................................................................................................................... 52
ManualLinuxSettings ................................................................................................................ 52
ManualSolverMemorySettings .................................................................................................. 52
MaxNumberOfCores ................................................................................................................. 52
NumberOfGPUDevices ............................................................................................................. 52
NumberOfProcesses ................................................................................................................. 52
SolveInSynchronousMode ........................................................................................................ 53
ThreadsPerProcess .................................................................................................................... 53
UseSharedLicense .................................................................................................................... 53
SolverMemorySettings ................................................................................................................... 53
SolverMemorySettings() ........................................................................................................... 53
Active ....................................................................................................................................... 54
Database .................................................................................................................................. 54
Workspace ................................................................................................................................ 54
Ansys.ACT.Mechanical.AdditionalProperties Namespace ................................................................. 55
ApplyCancelProperty ...................................................................................................................... 55
OnApply ................................................................................................................................... 55
Control ........................................................................................................................................... 55
DoubleProperty .............................................................................................................................. 56
ValidRange ............................................................................................................................... 56
ExpressionProperty ......................................................................................................................... 56
OptionsProperty ............................................................................................................................. 56
GetOptionsCallback .................................................................................................................. 57
Options .................................................................................................................................... 57
Ansys.ACT.Interfaces.DesignModeler Namespace ............................................................................. 59
IDesignModelerDataModel ............................................................................................................. 60
Components ............................................................................................................................ 60

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

GeoData ................................................................................................................................... 60
GeometryBuilder ...................................................................................................................... 61
Queries .................................................................................................................................... 61
ComponentById(int) ................................................................................................................. 61
CurrentUnitFromQuantityName(string) ..................................................................................... 61
IDesignModelerExtAPI .................................................................................................................... 61
IDesignModelerGeoData ................................................................................................................ 62
Bodies ...................................................................................................................................... 62
Parts ......................................................................................................................................... 62
IDesignModelerGeoFeature ............................................................................................................ 62
Bodies ...................................................................................................................................... 63
MaterialType ............................................................................................................................ 63
AddProblematicGeometry(IEnumerable<IPSGeoEntity>, string) ................................................ 63
IDesignModelerSelectionInfo .......................................................................................................... 63
Entities ..................................................................................................................................... 64
Locations .................................................................................................................................. 64
IExtrude ......................................................................................................................................... 64
Depth ....................................................................................................................................... 64
Direction .................................................................................................................................. 65
Walled ...................................................................................................................................... 65
ApplyTo(IPSGeoEntity) .............................................................................................................. 65
IGeometryBuilder ........................................................................................................................... 65
Operations ............................................................................................................................... 66
Primitives ................................................................................................................................. 66
IIntersect ........................................................................................................................................ 66
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 66
IOperations .................................................................................................................................... 66
Queries .................................................................................................................................... 67
Tools ........................................................................................................................................ 67
CreateExtrudeOperation(IEnumerable<double>, double) .......................................................... 67
CreateIntersectOperation(IEnumerable<IPSGeoBody>) ............................................................. 68
CreateRevolveOperation(IEnumerable<double>, IEnumerable<double>) .................................. 68
CreateSubtractOperation(IEnumerable<IPSGeoBody>) ............................................................. 68
CreateUnionOperation() ........................................................................................................... 69
IOperationTools .............................................................................................................................. 69
CopyBody(IPSGeoBody) ............................................................................................................ 70
CreatePart(IEnumerable<IPSGeoBody>) .................................................................................... 70
DeleteBody(IPSGeoBody) .......................................................................................................... 70
EdgesToWireBody(IEnumerable<IPSGeoEdge>) ........................................................................ 70
FacesToSheetBody(IEnumerable<IPSGeoFace>) ........................................................................ 71
Imprint(IPSGeoBody, IEnumerable<IPSGeoBody>) ..................................................................... 71
OffsetFace(IEnumerable<IPSGeoFace>, double) ........................................................................ 71
SheetBodyToSolidBody(IPSGeoBody) ........................................................................................ 72
SimplifyTopology(IPSGeoEntity) ................................................................................................ 72
ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, double, double) ..................................... 72
TransformBody(IPSGeoBody, Matrix4D) ..................................................................................... 73
WireToSheetBody(IPSGeoBody) ................................................................................................ 73
IPrimitives ...................................................................................................................................... 74
Sheet ....................................................................................................................................... 74
Solid ......................................................................................................................................... 74
Wire ......................................................................................................................................... 74

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

IPSGeoBody ................................................................................................................................... 74
IPSGeoEdge .................................................................................................................................... 75
IPSGeoEntity .................................................................................................................................. 75
IPSGeoFace .................................................................................................................................... 75
IPSGeoPart ..................................................................................................................................... 75
IQueries .......................................................................................................................................... 75
Clash(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) .............................................. 76
Coincidence(IPSGeoEntity, IPSGeoEntity) ................................................................................... 76
Containment(IPSGeoEntity, IPSGeoEntity) ................................................................................. 77
Distance(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) ......................................... 77
IRevolve ......................................................................................................................................... 77
Angle ....................................................................................................................................... 78
Axis .......................................................................................................................................... 78
Origin ....................................................................................................................................... 78
Walled ...................................................................................................................................... 78
ApplyTo(IPSGeoEntity) .............................................................................................................. 78
ISheetCone ..................................................................................................................................... 79
Center ...................................................................................................................................... 79
Direction .................................................................................................................................. 79
Radius1 .................................................................................................................................... 79
Radius2 .................................................................................................................................... 80
ISheetCylinder ................................................................................................................................ 80
Center ...................................................................................................................................... 80
Direction .................................................................................................................................. 80
Radius ...................................................................................................................................... 80
ISheetPolygon ................................................................................................................................ 81
Points ....................................................................................................................................... 81
ISheets ........................................................................................................................................... 81
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ..................................... 81
CreatePolygon(IEnumerable<double>) ..................................................................................... 82
ISheetSphere .................................................................................................................................. 82
Center ...................................................................................................................................... 82
Radius ...................................................................................................................................... 83
ISolidBox ........................................................................................................................................ 83
Point1 ...................................................................................................................................... 83
Point2 ...................................................................................................................................... 83
ISolidCone ...................................................................................................................................... 83
Center ...................................................................................................................................... 84
Direction .................................................................................................................................. 84
Radius1 .................................................................................................................................... 84
Radius2 .................................................................................................................................... 84
ISolidCylinder ................................................................................................................................. 85
Center ...................................................................................................................................... 85
Direction .................................................................................................................................. 85
Radius ...................................................................................................................................... 85
ISolids ............................................................................................................................................ 85
CreateBox(IEnumerable<double>, IEnumerable<double>) ........................................................ 86
CreateCone(IEnumerable<double>, IEnumerable<double>, double, double) ............................. 86
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ..................................... 87
CreateSphere(IEnumerable<double>, double) ........................................................................... 87
ISolidSphere ................................................................................................................................... 88

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

Center ...................................................................................................................................... 88
Radius ...................................................................................................................................... 88
ISubtract ........................................................................................................................................ 88
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 88
IUnion ............................................................................................................................................ 89
ApplyTo(IEnumerable<IPSGeoBody>) ....................................................................................... 89
IWireArc ......................................................................................................................................... 89
Center ...................................................................................................................................... 90
EndAngle ................................................................................................................................. 90
Normal ..................................................................................................................................... 90
Radius ...................................................................................................................................... 90
StartAngle ................................................................................................................................ 90
XDir .......................................................................................................................................... 91
IWireBCurve ................................................................................................................................... 91
Closed ...................................................................................................................................... 91
Points ....................................................................................................................................... 91
IWireEllipse ..................................................................................................................................... 91
Center ...................................................................................................................................... 92
LargeRadius ............................................................................................................................. 92
Normal ..................................................................................................................................... 92
SmallRadius .............................................................................................................................. 92
XDir .......................................................................................................................................... 93
IWirePolyline .................................................................................................................................. 93
Points ....................................................................................................................................... 93
IWires ............................................................................................................................................. 93
CreateArc(double, IEnumerable<double>, IEnumerable<double>, IEnumerable<double>) ......... 94
CreateBCurve(IEnumerable<double>) ....................................................................................... 94
CreateEllipse(double, double, IEnumerable<double>, IEnumerable<double>, IEnumer-
able<double>) ......................................................................................................................... 94
CreatePolyline(IEnumerable<double>) ...................................................................................... 95
Ansys.ACT.Interfaces.Graphics Namespace ....................................................................................... 97
IModelViewManager ...................................................................................................................... 97
NumberOfViews ....................................................................................................................... 98
ApplyModelView(int) ................................................................................................................ 98
ApplyModelView(string) ........................................................................................................... 98
CaptureModelView(int, string) .................................................................................................. 98
CaptureModelView(string, string) .............................................................................................. 99
CreateView() ............................................................................................................................. 99
CreateView(string) .................................................................................................................... 99
DeleteView(int) ........................................................................................................................ 99
DeleteView(string) .................................................................................................................. 100
ExportModelViews(string) ....................................................................................................... 100
ImportModelViews(string) ...................................................................................................... 100
RenameView(int, string) .......................................................................................................... 101
RenameView(string, string) ..................................................................................................... 101
Ansys.ACT.Interfaces.Mechanical Namespace ................................................................................. 103
IMechanicalDataModel ................................................................................................................. 103
ObjectTags ............................................................................................................................. 104
Project .................................................................................................................................... 104
Tree ........................................................................................................................................ 104
CurrentUnitFromQuantityName(string) ................................................................................... 104

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

GetUserObjectById(int) ........................................................................................................... 104

IMechanicalExtAPI ........................................................................................................................ 105
LockPrePostLicense() .............................................................................................................. 105
UnlockPrePostLicense() ........................................................................................................... 105
IMechanicalGraphics ..................................................................................................................... 105
ModelViewManager ............................................................................................................... 106
SectionPlanes ......................................................................................................................... 106
IMechanicalSelectionInfo .............................................................................................................. 106
ElementFaceIndices ................................................................................................................ 106
Entities ................................................................................................................................... 107
IMechanicalUserLoad .................................................................................................................... 107
IMechanicalUserObject ................................................................................................................. 107
Analysis .................................................................................................................................. 107
IMechanicalUserResult .................................................................................................................. 107
IMechanicalUserSolver .................................................................................................................. 108
MechanicalPanelEnum .................................................................................................................. 108
Ansys.ACT.Common Namespace ...................................................................................................... 109
CoordinateSystem ........................................................................................................................ 109
CoordinateSystem(CoordinateSystemTypeEnum) .................................................................... 110
CoordinateSystemType ........................................................................................................... 110
Id ........................................................................................................................................... 110
Matrix ..................................................................................................................................... 110
Name ..................................................................................................................................... 110
Origin ..................................................................................................................................... 111
XAxis ...................................................................................................................................... 111
YAxis ...................................................................................................................................... 111
ZAxis ...................................................................................................................................... 111
SimpleTransform .......................................................................................................................... 111
SimpleTransform() .................................................................................................................. 112
IsOrthonormal ........................................................................................................................ 112
TransformationMatrix ............................................................................................................. 112
Translation ............................................................................................................................. 112
XAxis ...................................................................................................................................... 112
YAxis ...................................................................................................................................... 113
ZAxis ...................................................................................................................................... 113
Ansys.ACT.Common.Graphics Namespace ....................................................................................... 115
DMCameraWrapper ...................................................................................................................... 115
DMGraphicsWrapper .................................................................................................................... 115
MechanicalCameraWrapper .......................................................................................................... 115
FocalPoint .............................................................................................................................. 116
SceneHeight ........................................................................................................................... 116
SceneWidth ............................................................................................................................ 117
UpVector ................................................................................................................................ 117
ViewVector ............................................................................................................................. 117
GetAsString(ApplicationType) ................................................................................................. 117
Pan(Quantity, Quantity) ........................................................................................................... 117
Rotate(double, CameraAxisType) ............................................................................................. 118
SetFit(ISelectionInfo) ............................................................................................................... 118
SetSpecificViewOrientation(ViewOrientationType) .................................................................. 118
Zoom(double) ........................................................................................................................ 119
MechanicalGraphicsWrapper ........................................................................................................ 119

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

Camera ................................................................................................................................... 120

GlobalLegendSettings ............................................................................................................ 120
KeyframeAnimationUtility ....................................................................................................... 120
ModelViewManager ............................................................................................................... 120
ResultAnimationOptions ......................................................................................................... 120
SectionPlanes ......................................................................................................................... 120
Unit ........................................................................................................................................ 121
ViewOptions ........................................................................................................................... 121
Export3D(string, Graphics3DExportFormat, Graphics3DExportSettings) ................................... 121
ExportImage(string, GraphicsImageExportFormat, GraphicsImageExportSettings) .................... 121
ModelViewManager ..................................................................................................................... 122
ActiveViewPort ....................................................................................................................... 123
NumberOfViews ..................................................................................................................... 123
ApplyModelView(int) .............................................................................................................. 123
ApplyModelView(string) ......................................................................................................... 123
CreateView() ........................................................................................................................... 123
CreateView(string) .................................................................................................................. 124
DeleteView(int) ....................................................................................................................... 124
DeleteView(string) .................................................................................................................. 124
ExportModelViews(string) ....................................................................................................... 124
ImportModelViews(string) ...................................................................................................... 125
RenameView(int, string) .......................................................................................................... 125
RenameView(string, string) ..................................................................................................... 125
SetActiveViewPort(int) ............................................................................................................ 126
SetActiveViewPort(int, int) ....................................................................................................... 126
SetViewPorts(int, bool) ............................................................................................................ 126
Ansys.ACT.Automation.DesignModeler Namespace ....................................................................... 129
Extrusion ...................................................................................................................................... 129
Depth ..................................................................................................................................... 130
Depth2 ................................................................................................................................... 130
Thin1 ...................................................................................................................................... 130
Thin2 ...................................................................................................................................... 130
Walled .................................................................................................................................... 130
Feature ......................................................................................................................................... 130
Id ........................................................................................................................................... 131
Name ..................................................................................................................................... 131
FeatureManager ........................................................................................................................... 131
Count ..................................................................................................................................... 131
Item(int) ................................................................................................................................. 132
CreateNamedSelection() ......................................................................................................... 132
Generate() .............................................................................................................................. 132
NamedSelection ........................................................................................................................... 132
ExportNamedSelection ........................................................................................................... 133
IncludeInLegend ..................................................................................................................... 133
NumGeometry ....................................................................................................................... 133
PropagateNamedSelection ..................................................................................................... 133
Ansys.ACT.Automation.Mechanical Namespace .............................................................................. 135
AcousticsFarFieldResultWorksheet ................................................................................................ 140
RowCount .............................................................................................................................. 141
AddRow() ............................................................................................................................... 141
DeleteRow(int) ....................................................................................................................... 141

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

DuplicateRow(int, int) ............................................................................................................. 141

GetCoordinateSystemSelection(int) ........................................................................................ 142
GetXCoordinate(int) ................................................................................................................ 142
GetYCoordinate(int) ................................................................................................................ 142
GetZCoordinate(int) ................................................................................................................ 143
InsertRow(int) ......................................................................................................................... 143
SetCoordinateSystemSelection(int, uint) .................................................................................. 143
SetXCoordinate(int, double) .................................................................................................... 144
SetYCoordinate(int, double) .................................................................................................... 144
SetZCoordinate(int, double) .................................................................................................... 144
AMOverhangConstraint ................................................................................................................ 145
BuildDirection ........................................................................................................................ 145
CoordinateSystem .................................................................................................................. 146
DataModelObjectCategory ..................................................................................................... 146
InternalObject ........................................................................................................................ 146
OverhangAngle ...................................................................................................................... 146
ScopingMethod ...................................................................................................................... 146
Analysis ........................................................................................................................................ 146
Acoustics ................................................................................................................................ 151
AMProcessSimulation ............................................................................................................. 152
AnalysisSettings ..................................................................................................................... 152
AnalysisType ........................................................................................................................... 152
CellId ...................................................................................................................................... 152
Children ................................................................................................................................. 152
Comments .............................................................................................................................. 152
DataModelObjectCategory ..................................................................................................... 153
Electric ................................................................................................................................... 153
EnvironmentTemperature ....................................................................................................... 153
Figures ................................................................................................................................... 153
GenerateInputOnly ................................................................................................................. 153
Images ................................................................................................................................... 153
InitialConditions ..................................................................................................................... 154
InternalObject ........................................................................................................................ 154
PhysicsType ............................................................................................................................ 154
ResultFileName ....................................................................................................................... 154
Solution ................................................................................................................................. 154
Structural ............................................................................................................................... 154
SystemCaption ....................................................................................................................... 155
Thermal .................................................................................................................................. 155
AddAcceleration() ................................................................................................................... 155
AddAcousticAbsorptionElement() ........................................................................................... 155
AddAcousticAbsorptionSurface() ............................................................................................ 155
AddAcousticDiffuseSoundField() ............................................................................................. 155
AddAcousticFarFieldRadationSurface() .................................................................................... 156
AddAcousticFreeSurface() ....................................................................................................... 156
AddAcousticImpedanceBoundary() ......................................................................................... 156
AddAcousticImpedanceSheet() ............................................................................................... 156
AddAcousticIncidentWaveSource() .......................................................................................... 156
AddAcousticLowReducedFrequency() ..................................................................................... 156
AddAcousticMassSource() ....................................................................................................... 157
AddAcousticMassSourceRate() ................................................................................................ 157

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

AddAcousticPort() .................................................................................................................. 157

AddAcousticPortInDuct() ........................................................................................................ 157
AddAcousticPressure() ............................................................................................................ 157
AddAcousticRadiationBoundary() ........................................................................................... 157
AddAcousticRigidWall() ........................................................................................................... 158
AddAcousticStaticPressure() .................................................................................................... 158
AddAcousticSurfaceAcceleration() .......................................................................................... 158
AddAcousticSurfaceVelocity() ................................................................................................. 158
AddAcousticSymmetryPlane() ................................................................................................. 158
AddAcousticTemperature() ..................................................................................................... 158
AddAcousticThermoViscousBLIBoundary() .............................................................................. 159
AddAcousticTransferAdmittanceMatrix() ................................................................................. 159
AddAMOverhangConstraint() .................................................................................................. 159
AddBearingLoad() ................................................................................................................... 159
AddBodyControl() ................................................................................................................... 159
AddBoltPretension() ............................................................................................................... 159
AddCenterOfGravityConstraint() ............................................................................................. 160
AddCommandSnippet() .......................................................................................................... 160
AddComment() ....................................................................................................................... 160
AddComplianceConstraint() .................................................................................................... 160
AddCompressionOnlySupport() .............................................................................................. 160
AddConstraintEquation() ........................................................................................................ 160
AddContactStepControl() ........................................................................................................ 161
AddConvection() .................................................................................................................... 161
AddCoupling() ........................................................................................................................ 161
AddCriterionConstraint() ......................................................................................................... 161
AddCurrent() .......................................................................................................................... 161
AddCyclicManufacturingConstraint() ....................................................................................... 161
AddCylindricalSupport() ......................................................................................................... 162
AddDetonationPoint() ............................................................................................................. 162
AddDisplacement() ................................................................................................................. 162
AddDisplacementConstraint() ................................................................................................. 162
AddDynamicComplianceConstraint() ...................................................................................... 162
AddEarthGravity() ................................................................................................................... 162
AddElasticSupport() ................................................................................................................ 163
AddElectricCharge() ................................................................................................................ 163
AddElementBirthAndDeath() .................................................................................................. 163
AddEMTransducer() ................................................................................................................ 163
AddExtrusionManufacturingConstraint() ................................................................................. 163
AddFigure() ............................................................................................................................ 163
AddFixedRotation() ................................................................................................................. 164
AddFixedSupport() ................................................................................................................. 164
AddFluidSolidInterface() ......................................................................................................... 164
AddForce() .............................................................................................................................. 164
AddFrictionlessSupport() ........................................................................................................ 164
AddGeneralizedPlaneStrain() .................................................................................................. 164
AddGlobalVonMisesStressConstraint() ..................................................................................... 165
AddHeatFlow() ....................................................................................................................... 165
AddHeatFlux() ........................................................................................................................ 165
AddHousingConstraint() ......................................................................................................... 165
AddHydrostaticPressure() ........................................................................................................ 165

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

AddImage(string) ................................................................................................................... 165

AddImpedanceBoundary() ...................................................................................................... 166
AddImportedCFDPressure() .................................................................................................... 166
AddImportedLoadExternalData() ............................................................................................ 166
AddImportedLoadResultFile() ................................................................................................. 166
AddImportedRemoteLoadsGroup() ......................................................................................... 166
AddInitialVelocity() ................................................................................................................. 167
AddInternalHeatGeneration() .................................................................................................. 167
AddJointLoad() ....................................................................................................................... 167
AddLimitBoundary() ............................................................................................................... 167
AddLinePressure() ................................................................................................................... 167
AddLocalVonMisesStressConstraint() ....................................................................................... 167
AddMagneticFluxParallel() ...................................................................................................... 168
AddMassConstraint() .............................................................................................................. 168
AddMassFlowRate() ................................................................................................................ 168
AddMemberSizeManufacturingConstraint() ............................................................................ 168
AddMoment() ......................................................................................................................... 168
AddMomentOfInertiaConstraint() ........................................................................................... 168
AddNaturalFrequencyConstraint() ........................................................................................... 169
AddNodalDisplacement() ........................................................................................................ 169
AddNodalForce() .................................................................................................................... 169
AddNodalOrientation() ........................................................................................................... 169
AddNodalPressure() ................................................................................................................ 169
AddNodalRotation() ................................................................................................................ 169
AddNonlinearAdaptiveRegion() .............................................................................................. 170
AddObjective() ....................................................................................................................... 170
AddOptimizationRegion() ....................................................................................................... 170
AddPatternRepetitionConstraint() ........................................................................................... 170
AddPerfectlyInsulated() .......................................................................................................... 170
AddPhysicsRegion() ................................................................................................................ 170
AddPipeIdealization() ............................................................................................................. 171
AddPipePressure() .................................................................................................................. 171
AddPipeTemperature() ............................................................................................................ 171
AddPlasticHeating() ................................................................................................................ 171
AddPressure() ......................................................................................................................... 171
AddPSDAcceleration() ............................................................................................................. 171
AddPSDDisplacement() ........................................................................................................... 172
AddPSDGAcceleration() .......................................................................................................... 172
AddPSDVelocity() .................................................................................................................... 172
AddPullOutDirectionManufacturingConstraint() ...................................................................... 172
AddPythonCodeEventBased() ................................................................................................. 172
AddRadiation() ....................................................................................................................... 172
AddReactionForceConstraint() ................................................................................................ 173
AddRemoteDisplacement() ..................................................................................................... 173
AddRemoteForce() .................................................................................................................. 173
AddRotatingForce() ................................................................................................................ 173
AddRotationalAcceleration() ................................................................................................... 173
AddRotationalVelocity() .......................................................................................................... 173
AddRSAcceleration() ............................................................................................................... 174
AddRSDisplacement() ............................................................................................................. 174
AddRSVelocity() ...................................................................................................................... 174

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

AddSimplySupported() ........................................................................................................... 174

AddSourceConductor() ........................................................................................................... 174
AddSubstructureGenerationCondensedPart() ......................................................................... 174
AddSurfaceChargeDensity() .................................................................................................... 175
AddSymmetryManufacturingConstraint() ................................................................................ 175
AddSystemCouplingRegion() .................................................................................................. 175
AddTemperature() .................................................................................................................. 175
AddTemperatureConstraint() .................................................................................................. 175
AddThermalComplianceConstraint() ....................................................................................... 175
AddThermalCondition() .......................................................................................................... 176
AddUniformConstraint() ......................................................................................................... 176
AddVelocity() .......................................................................................................................... 176
AddViscoelasticHeating() ........................................................................................................ 176
AddVoltage() .......................................................................................................................... 176
AddVoltageCoupling() ............................................................................................................ 176
AddVoltageGround() ............................................................................................................... 177
AddVolumeChargeDensity() .................................................................................................... 177
AddVolumeConstraint() .......................................................................................................... 177
ClearGeneratedData() ............................................................................................................. 177
CreateAutomaticFarFieldRadiationSurfaces() ........................................................................... 177
CreateAutomaticFSI() .............................................................................................................. 177
CreateAutomaticFSIandFarFieldRadiationSurfaces() ................................................................. 178
Delete() .................................................................................................................................. 178
Duplicate() .............................................................................................................................. 178
ExportNastranFile(NastranExportOptions) ............................................................................... 178
FilterBasedOnEnvironment() ................................................................................................... 178
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 179
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 179
ImportLoad(Analysis) .............................................................................................................. 179
OpenSolverFilesDirectory() ..................................................................................................... 180
SelectBodiesWithMultiplePhysicsRegion() ............................................................................... 180
SelectBodiesWithoutPhysicsRegion() ...................................................................................... 180
Solve(bool) ............................................................................................................................. 180
Solve(bool, string) ................................................................................................................... 181
TransferDataFrom(Analysis) ..................................................................................................... 181
UnlinkDataFrom(Analysis) ....................................................................................................... 181
WriteSystemCouplingFiles(string) ............................................................................................ 181
AnalysisPly ................................................................................................................................... 182
Angle ..................................................................................................................................... 183
Children ................................................................................................................................. 183
Comments .............................................................................................................................. 183
DataModelObjectCategory ..................................................................................................... 183
Figures ................................................................................................................................... 183
IDInSource .............................................................................................................................. 183
Images ................................................................................................................................... 184
InternalObject ........................................................................................................................ 184
Material .................................................................................................................................. 184
NameInSource ........................................................................................................................ 184
NumberOfElements ................................................................................................................ 184
Thickness ............................................................................................................................... 184
AddComment() ....................................................................................................................... 185

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

AddFigure() ............................................................................................................................ 185

AddImage(string) ................................................................................................................... 185
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 185
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 186
ArbitraryCrack .............................................................................................................................. 186
BottomFaceNodes .................................................................................................................. 187
CircumferentialDivisions ......................................................................................................... 187
CoordinateSystem .................................................................................................................. 188
CrackFacesNodes .................................................................................................................... 188
CrackFrontNodes .................................................................................................................... 188
CrackMeshMethod ................................................................................................................. 188
CrackShape ............................................................................................................................ 188
CrackSourceType .................................................................................................................... 188
CrackSurfaceLocation ............................................................................................................. 189
DataModelObjectCategory ..................................................................................................... 189
FrontElementSize .................................................................................................................... 189
GrowthRate ............................................................................................................................ 189
InternalObject ........................................................................................................................ 189
LargestContourRadius ............................................................................................................ 189
Location ................................................................................................................................. 190
MeshContours ........................................................................................................................ 190
SolutionContours ................................................................................................................... 190
Suppressed ............................................................................................................................ 190
TopFaceNodes ........................................................................................................................ 190
XScaleFactor ........................................................................................................................... 190
YScaleFactor ........................................................................................................................... 191
ZScaleFactor ........................................................................................................................... 191
BatchConnectionsWorksheet ........................................................................................................ 191
RowCount .............................................................................................................................. 192
AddRow() ............................................................................................................................... 192
ClearGenerateMesh() .............................................................................................................. 192
DeleteAllRows() ...................................................................................................................... 192
DeleteRow(int) ....................................................................................................................... 192
GenerateAtRow(int) ................................................................................................................ 193
GenerateMesh() ...................................................................................................................... 193
GetActiveState(int) ................................................................................................................. 193
GetConnectionOption(int) ...................................................................................................... 193
GetConnectionTolerances(int) ................................................................................................. 194
GetNamedSelection(int) ......................................................................................................... 194
GetNamedSelectionId(int) ...................................................................................................... 194
SetActiveState(int, bool) .......................................................................................................... 195
SetConnectionOption(int, int) ................................................................................................. 195
SetConnectionTolerances(int, string) ....................................................................................... 195
SetNamedSelection(int, NamedSelection) ............................................................................... 196
SetNamedSelectionId(int, uint) ................................................................................................ 196
Body ............................................................................................................................................ 196
Assignment ***OBSOLETE*** Use 'Material' property instead. .................................................. 199
Average .................................................................................................................................. 199
BeamSection .......................................................................................................................... 200
Behavior ................................................................................................................................. 200
BrickIntegrationScheme .......................................................................................................... 200

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

CentroidX ............................................................................................................................... 200

CentroidY ............................................................................................................................... 200
CentroidZ ............................................................................................................................... 200
Children ................................................................................................................................. 201
Comments .............................................................................................................................. 201
ConfigurationId ...................................................................................................................... 201
CoordinateSystem .................................................................................................................. 201
CrossSectionArea .................................................................................................................... 201
CrossSectionIYY ...................................................................................................................... 201
CrossSectionIZZ ...................................................................................................................... 202
CrossSectionName .................................................................................................................. 202
CrossSectionSelection ............................................................................................................ 202
DataModelObjectCategory ..................................................................................................... 202
Dimension .............................................................................................................................. 202
Elements ................................................................................................................................ 202
FiberAngle .............................................................................................................................. 203
FiberCrossSectionArea ............................................................................................................ 203
FiberSpacing .......................................................................................................................... 203
Figures ................................................................................................................................... 203
FluidCrossArea ........................................................................................................................ 203
FluidDiscretization .................................................................................................................. 203
FluidSolidPhase ...................................................................................................................... 204
GeometryType ........................................................................................................................ 204
Hidden ................................................................................................................................... 204
HomogeneousMembrane ....................................................................................................... 204
Images ................................................................................................................................... 204
InternalObject ........................................................................................................................ 204
IsWindingBody ....................................................................................................................... 205
Length ................................................................................................................................... 205
LengthX ................................................................................................................................. 205
LengthY ................................................................................................................................. 205
LengthZ ................................................................................................................................. 205
LinkTrussBehavior ................................................................................................................... 205
ManualThicknessMode ........................................................................................................... 206
Mass ....................................................................................................................................... 206
Material .................................................................................................................................. 206
Maximum ............................................................................................................................... 206
MeshMetric ............................................................................................................................ 206
MeshVersion ........................................................................................................................... 206
Minimum ............................................................................................................................... 207
ModelType ............................................................................................................................. 207
MomentOfInertiaIp1 ............................................................................................................... 207
MomentOfInertiaIp2 ............................................................................................................... 207
MomentOfInertiaIp3 ............................................................................................................... 207
Nodes ..................................................................................................................................... 207
NonlinearEffects ..................................................................................................................... 208
NumberOfTurns ...................................................................................................................... 208
OffsetMode ............................................................................................................................ 208
OffsetType .............................................................................................................................. 208
OffsetX ................................................................................................................................... 208
OffsetY ................................................................................................................................... 208

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

PipeExternalDiameter ............................................................................................................. 209

PipeInternalDiameter .............................................................................................................. 209
PipeThickness ......................................................................................................................... 209
ReferenceFrame ...................................................................................................................... 209
ReferenceTemperature ***OBSOLETE*** Use 'UseReferenceTemperatureByBody' property in-
stead. ..................................................................................................................................... 209
ReferenceTemperatureValue ................................................................................................... 209
ReinforcingStressState ............................................................................................................ 210
ResultMeshId .......................................................................................................................... 210
ShellOffsetType ...................................................................................................................... 210
StandardDeviation .................................................................................................................. 210
StiffnessBehavior .................................................................................................................... 210
StiffnessOption ....................................................................................................................... 210
Suppressed ............................................................................................................................ 211
SuppressedParameterized ...................................................................................................... 211
SurfaceArea ............................................................................................................................ 211
ThermalStrainEffects ............................................................................................................... 211
Thickness ............................................................................................................................... 211
ThicknessMode ***OBSOLETE*** Use 'ManualThicknessMode' property instead. ...................... 211
Treatment ............................................................................................................................... 212
UseReferenceTemperatureByBody .......................................................................................... 212
UserNameChange ................................................................................................................... 212
Visible .................................................................................................................................... 212
Volume ................................................................................................................................... 212
AddCommandSnippet() .......................................................................................................... 212
AddComment() ....................................................................................................................... 213
AddFigure() ............................................................................................................................ 213
AddImage(string) ................................................................................................................... 213
AddPythonCodeEventBased() ................................................................................................. 213
ClearGeneratedData() ............................................................................................................. 213
GenerateMesh() ...................................................................................................................... 214
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 214
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 214
GetGeoBody() ......................................................................................................................... 215
PreviewInflation() ................................................................................................................... 215
PreviewSurfaceMesh() ............................................................................................................ 215
ShowBody() ............................................................................................................................ 215
Update() ................................................................................................................................. 215
CenterOfGravityConstraint ............................................................................................................ 215
Axis ........................................................................................................................................ 216
DataModelObjectCategory ..................................................................................................... 216
InternalObject ........................................................................................................................ 216
Location ................................................................................................................................. 217
MaximumPosition ................................................................................................................... 217
MinimumPosition ................................................................................................................... 217
ScopingMethod ...................................................................................................................... 217
Selection ................................................................................................................................ 217
ChannelCrossSection .................................................................................................................... 217
Area ....................................................................................................................................... 218
DataModelObjectCategory ..................................................................................................... 218
InternalObject ........................................................................................................................ 219

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

IYY ......................................................................................................................................... 219

IZZ ......................................................................................................................................... 219
Thick1 .................................................................................................................................... 219
Thick2 .................................................................................................................................... 219
Thick3 .................................................................................................................................... 219
Width1 ................................................................................................................................... 220
Width2 ................................................................................................................................... 220
Width3 ................................................................................................................................... 220
Chart ............................................................................................................................................ 220
Caption .................................................................................................................................. 221
Children ................................................................................................................................. 221
Comments .............................................................................................................................. 221
Content .................................................................................................................................. 221
DataModelObjectCategory ..................................................................................................... 222
Gridlines ................................................................................................................................. 222
Images ................................................................................................................................... 222
InternalObject ........................................................................................................................ 222
ModalDisplayType .................................................................................................................. 222
OutlineSelection ..................................................................................................................... 222
PlotStyle ................................................................................................................................. 223
Scale ...................................................................................................................................... 223
XAxis ...................................................................................................................................... 223
XAxisLabel .............................................................................................................................. 223
YAxisLabel .............................................................................................................................. 223
AddComment() ....................................................................................................................... 223
AddImage(string) ................................................................................................................... 224
Delete() .................................................................................................................................. 224
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 224
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 225
ChartXAxis .................................................................................................................................... 225
ComponentIndex ................................................................................................................... 225
ObjectSelection ...................................................................................................................... 226
CircularCrossSection ..................................................................................................................... 226
Area ....................................................................................................................................... 226
DataModelObjectCategory ..................................................................................................... 227
InternalObject ........................................................................................................................ 227
IYY ......................................................................................................................................... 227
IZZ ......................................................................................................................................... 227
Radius .................................................................................................................................... 227
CircularTubeCrossSection ............................................................................................................. 227
Area ....................................................................................................................................... 228
DataModelObjectCategory ..................................................................................................... 228
InnerRadius ............................................................................................................................ 228
InternalObject ........................................................................................................................ 229
IYY ......................................................................................................................................... 229
IZZ ......................................................................................................................................... 229
OuterRadius ........................................................................................................................... 229
CommandSnippet ........................................................................................................................ 229
Children ................................................................................................................................. 231
Comments .............................................................................................................................. 231
DataModelObjectCategory ..................................................................................................... 231

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

Figures ................................................................................................................................... 231

FileName ................................................................................................................................ 231
Images ................................................................................................................................... 231
Input ...................................................................................................................................... 232
InputArgument1 ..................................................................................................................... 232
InputArgument2 ..................................................................................................................... 232
InputArgument3 ..................................................................................................................... 232
InputArgument4 ..................................................................................................................... 232
InputArgument5 ..................................................................................................................... 232
InputArgument6 ..................................................................................................................... 233
InputArgument7 ..................................................................................................................... 233
InputArgument8 ..................................................................................................................... 233
InputArgument9 ..................................................................................................................... 233
InternalObject ........................................................................................................................ 233
InvalidateSolution ................................................................................................................... 233
IssueSolveCommand .............................................................................................................. 234
OutputParameters .................................................................................................................. 234
OutputSearchPrefix ................................................................................................................ 234
SnippetFileStatus .................................................................................................................... 234
SolverTarget ........................................................................................................................... 234
StepNumber ........................................................................................................................... 234
StepSelectionMode ................................................................................................................ 235
Suppressed ............................................................................................................................ 235
AddComment() ....................................................................................................................... 235
AddFigure() ............................................................................................................................ 235
AddImage(string) ................................................................................................................... 235
AppendText(string) ................................................................................................................. 236
Delete() .................................................................................................................................. 236
ExportTextFile(string) .............................................................................................................. 236
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 236
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 237
ImportTextFile(string) ............................................................................................................. 237
RenameBasedOnDefinition() ................................................................................................... 238
Comment ..................................................................................................................................... 238
Author .................................................................................................................................... 238
Children ................................................................................................................................. 238
DataModelObjectCategory ..................................................................................................... 239
InternalObject ........................................................................................................................ 239
Text ........................................................................................................................................ 239
Delete() .................................................................................................................................. 239
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 239
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 240
ComplianceConstraint .................................................................................................................. 240
ComplianceLimit .................................................................................................................... 241
DataModelObjectCategory ..................................................................................................... 241
InternalObject ........................................................................................................................ 241
CompositeCriterion ...................................................................................................................... 241
DataModelObjectCategory ..................................................................................................... 242
InternalObject ........................................................................................................................ 242
Value ...................................................................................................................................... 242
ClearGeneratedData() ............................................................................................................. 242

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

EvaluateAllResults() ................................................................................................................. 243

GetDefinition() ........................................................................................................................ 243
CompositeCriterionDefinition ....................................................................................................... 243
Count ..................................................................................................................................... 243
Item(int) ................................................................................................................................. 244
Add(CompositeCriterionTerm) ................................................................................................ 244
Clear() .................................................................................................................................... 244
IndexOf(CompositeCriterionTerm) .......................................................................................... 244
Insert(int, CompositeCriterionTerm) ......................................................................................... 245
RemoveAt(int) ........................................................................................................................ 245
CompositeCriterionTerm ............................................................................................................... 245
CompositeCriterionTerm() ....................................................................................................... 246
CompositeCriterionTerm(PrimaryCriterion, double) ................................................................. 246
Coefficient .............................................................................................................................. 246
PrimaryCriterion ..................................................................................................................... 246
CondensedGeometry .................................................................................................................... 247
Children ................................................................................................................................. 247
Comments .............................................................................................................................. 248
DataModelObjectCategory ..................................................................................................... 248
Figures ................................................................................................................................... 248
Images ................................................................................................................................... 248
InternalObject ........................................................................................................................ 248
SolverFilesDirectory ................................................................................................................ 248
TransparencyEnabled ............................................................................................................. 249
AddComment() ....................................................................................................................... 249
AddCondensedPart() .............................................................................................................. 249
AddCondensedPartInfoTool() .................................................................................................. 249
AddFigure() ............................................................................................................................ 249
AddImage(string) ................................................................................................................... 249
AddImportedCondensedPart() ................................................................................................ 250
ClearGeneratedData() ............................................................................................................. 250
CreateAutomaticCondensedParts() ......................................................................................... 250
Delete() .................................................................................................................................. 250
GenerateCondensedParts() ..................................................................................................... 250
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 251
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 251
CondensedPart ............................................................................................................................. 251
AttachmentMethod ................................................................................................................ 253
DataModelObjectCategory ..................................................................................................... 253
FutureExpansion ..................................................................................................................... 254
FutureIntent ........................................................................................................................... 254
GenerateDampingMatrix ........................................................................................................ 254
InterfaceMethod ..................................................................................................................... 254
Interfaces ............................................................................................................................... 254
InternalObject ........................................................................................................................ 254
KeepFilesFor ........................................................................................................................... 255
LumpedMassFormulation ....................................................................................................... 255
MaximumFrequency ............................................................................................................... 255
MinimumFrequency ............................................................................................................... 255
NumberOfModes .................................................................................................................... 255
PointMassTreatment ............................................................................................................... 255

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

RangeSearch .......................................................................................................................... 256

ReductionMethod .................................................................................................................. 256
SolverType .............................................................................................................................. 256
StoreBasisResults .................................................................................................................... 256
DetectCondensedPartInterface() ............................................................................................. 256
ExportCondensedPart(string) .................................................................................................. 256
GenerateCondensedParts() ..................................................................................................... 257
CondensedPartBase ...................................................................................................................... 257
Children ................................................................................................................................. 258
Comments .............................................................................................................................. 258
DataModelObjectCategory ..................................................................................................... 258
Figures ................................................................................................................................... 258
GeometrySelection ................................................................................................................. 259
Images ................................................................................................................................... 259
InternalObject ........................................................................................................................ 259
NumberInterfaceEntries .......................................................................................................... 259
NumberMasterNodes ............................................................................................................. 259
Physics ................................................................................................................................... 259
ReferenceTemperature ............................................................................................................ 260
SolutionName ........................................................................................................................ 260
SolutionNameMode ................................................................................................................ 260
SolverFilesDirectory ................................................................................................................ 260
SolverUnits ............................................................................................................................. 260
SolverUnitSystem ................................................................................................................... 260
Suppressed ............................................................................................................................ 261
TemperatureUnits ................................................................................................................... 261
AddCommandSnippet() .......................................................................................................... 261
AddComment() ....................................................................................................................... 261
AddFigure() ............................................................................................................................ 261
AddImage(string) ................................................................................................................... 261
ClearGeneratedData() ............................................................................................................. 262
Delete() .................................................................................................................................. 262
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 262
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 262
CondensedPartExpansionState ..................................................................................................... 263
CondensedPartExpansionState() ............................................................................................. 263
Displacement ......................................................................................................................... 263
Stress ..................................................................................................................................... 264
CondensedPartInfoTool ................................................................................................................ 264
Children ................................................................................................................................. 264
Comments .............................................................................................................................. 265
DataModelObjectCategory ..................................................................................................... 265
Images ................................................................................................................................... 265
InternalObject ........................................................................................................................ 265
Text ........................................................................................................................................ 265
UpdateInterval ....................................................................................................................... 265
AddComment() ....................................................................................................................... 266
AddImage(string) ................................................................................................................... 266
Delete() .................................................................................................................................. 266
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 266
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 267

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

CondensedPartInterface ............................................................................................................... 267

AllSelection ............................................................................................................................ 267
NamedSelection ..................................................................................................................... 268
RemotePointSelection ............................................................................................................ 268
Type ....................................................................................................................................... 268
CondensedPartInterfaces .............................................................................................................. 268
Item(int) ................................................................................................................................. 269
Add() ...................................................................................................................................... 269
Clear() .................................................................................................................................... 269
RemoveAt(int) ........................................................................................................................ 269
ConstructionGeometry ................................................................................................................. 269
Children ................................................................................................................................. 270
Comments .............................................................................................................................. 271
DataModelObjectCategory ..................................................................................................... 271
Figures ................................................................................................................................... 271
Images ................................................................................................................................... 271
InternalObject ........................................................................................................................ 271
ShowMesh ............................................................................................................................. 271
AddComment() ....................................................................................................................... 272
AddConstructionLine() ............................................................................................................ 272
AddConstructionPoint() .......................................................................................................... 272
AddFigure() ............................................................................................................................ 272
AddImage(string) ................................................................................................................... 272
AddPath() ............................................................................................................................... 273
AddSolid() .............................................................................................................................. 273
AddSTL() ................................................................................................................................. 273
AddSurface() .......................................................................................................................... 273
Delete() .................................................................................................................................. 273
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 273
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 274
UpdateAllSolids() .................................................................................................................... 274
UpdateSolids() ........................................................................................................................ 274
ConstructionPoint ......................................................................................................................... 275
Children ................................................................................................................................. 275
Comments .............................................................................................................................. 275
DataModelObjectCategory ..................................................................................................... 276
Figures ................................................................................................................................... 276
Images ................................................................................................................................... 276
InternalObject ........................................................................................................................ 276
LocationX ............................................................................................................................... 276
LocationY ............................................................................................................................... 276
LocationZ ............................................................................................................................... 277
SetLocation ............................................................................................................................ 277
AddComment() ....................................................................................................................... 277
AddFigure() ............................................................................................................................ 277
AddImage(string) ................................................................................................................... 277
Delete() .................................................................................................................................. 278
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 278
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 278
ContactDebonding ....................................................................................................................... 279
ContactRegion ........................................................................................................................ 279

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

CriticalRate ............................................................................................................................. 280

DataModelObjectCategory ..................................................................................................... 280
GenerationMethod ................................................................................................................. 280
InitialCrack ............................................................................................................................. 280
InitialTimeStep ....................................................................................................................... 280
InternalObject ........................................................................................................................ 280
Material .................................................................................................................................. 281
MaximumTimeStep ................................................................................................................ 281
Method .................................................................................................................................. 281
MinimumTimeStep ................................................................................................................. 281
Suppressed ............................................................................................................................ 281
Type ....................................................................................................................................... 281
AddCommandSnippet() .......................................................................................................... 282
Delete() .................................................................................................................................. 282
ContactMatch ............................................................................................................................... 282
DataModelObjectCategory ..................................................................................................... 284
InternalObject ........................................................................................................................ 284
ContactMatchGroup ..................................................................................................................... 284
DataModelObjectCategory ..................................................................................................... 286
InternalObject ........................................................................................................................ 286
ContactSolutionInformation ......................................................................................................... 286
Children ................................................................................................................................. 287
Comments .............................................................................................................................. 287
DataModelObjectCategory ..................................................................................................... 287
Images ................................................................................................................................... 288
InternalObject ........................................................................................................................ 288
UpdateInterval ....................................................................................................................... 288
AddComment() ....................................................................................................................... 288
AddImage(string) ................................................................................................................... 288
Delete() .................................................................................................................................. 289
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 289
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 289
CoordinateSystem ........................................................................................................................ 290
APDLName ............................................................................................................................. 292
Children ................................................................................................................................. 292
Comments .............................................................................................................................. 292
CoordinateSystemID ............................................................................................................... 292
CoordinateSystemIDGeneration .............................................................................................. 292
CoordinateSystemType ........................................................................................................... 293
DataModelObjectCategory ..................................................................................................... 293
Figures ................................................................................................................................... 293
GloballyAvailable .................................................................................................................... 293
Images ................................................................................................................................... 293
InternalObject ........................................................................................................................ 293
IsGlobal .................................................................................................................................. 294
OriginDefineBy ....................................................................................................................... 294
OriginLocation ........................................................................................................................ 294
OriginX ................................................................................................................................... 294
OriginY ................................................................................................................................... 294
OriginZ ................................................................................................................................... 294
PrimaryAxis ............................................................................................................................ 295

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

PrimaryAxisDefineBy .............................................................................................................. 295

PrimaryAxisDirection .............................................................................................................. 295
PrimaryAxisLocation ............................................................................................................... 295
SecondaryAxis ........................................................................................................................ 295
SecondaryAxisDefineBy .......................................................................................................... 295
SecondaryAxisDirection .......................................................................................................... 296
SecondaryAxisLocation ........................................................................................................... 296
Suppressed ............................................................................................................................ 296
TransformationCount .............................................................................................................. 296
TransformedConfiguration ...................................................................................................... 296
XAxisData ............................................................................................................................... 296
YAxisData ............................................................................................................................... 297
ZAxisData ............................................................................................................................... 297
AddComment() ....................................................................................................................... 297
AddFigure() ............................................................................................................................ 297
AddImage(string) ................................................................................................................... 297
AddTransformation(TransformationType, CoordinateSystemAxisType) ..................................... 298
CreateConstructionSurface() ................................................................................................... 298
CreateSectionPlane() .............................................................................................................. 298
Delete() .................................................................................................................................. 298
FlipX() ..................................................................................................................................... 299
FlipY() ..................................................................................................................................... 299
FlipZ() ..................................................................................................................................... 299
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 299
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 299
GetTransformationValue(uint) ................................................................................................. 300
MoveTransformationDown(uint) ............................................................................................. 300
MoveTransformationUp(uint) .................................................................................................. 301
OffsetX() ................................................................................................................................. 301
OffsetX(object) ....................................................................................................................... 301
OffsetY() ................................................................................................................................. 301
OffsetY(object) ....................................................................................................................... 301
OffsetZ() ................................................................................................................................. 302
OffsetZ(object) ....................................................................................................................... 302
RemoveTransformation(uint) .................................................................................................. 302
RotateX() ................................................................................................................................ 302
RotateX(object) ...................................................................................................................... 303
RotateY() ................................................................................................................................ 303
RotateY(object) ....................................................................................................................... 303
RotateZ() ................................................................................................................................ 303
RotateZ(object) ...................................................................................................................... 304
SetOriginLocation(Quantity, Quantity, Quantity) ...................................................................... 304
SetTransformationValue(uint, object) ....................................................................................... 304
CoordinateSystems ....................................................................................................................... 305
Children ................................................................................................................................. 305
Comments .............................................................................................................................. 305
DataModelObjectCategory ..................................................................................................... 306
Figures ................................................................................................................................... 306
Images ................................................................................................................................... 306
InternalObject ........................................................................................................................ 306
AddComment() ....................................................................................................................... 306

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

AddCoordinateSystem() .......................................................................................................... 306

AddFigure() ............................................................................................................................ 307
AddImage(string) ................................................................................................................... 307
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 307
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 308
CoSimulationPin ........................................................................................................................... 308
Children ................................................................................................................................. 309
DataModelObjectCategory ..................................................................................................... 309
DOF ........................................................................................................................................ 309
InternalObject ........................................................................................................................ 309
JointType ................................................................................................................................ 309
PinBehavior ............................................................................................................................ 310
PinNature ............................................................................................................................... 310
Scope ..................................................................................................................................... 310
Suppressed ............................................................................................................................ 310
Delete() .................................................................................................................................. 310
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 310
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 311
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack instead. ........... 311
AlignWithFaceNormal ............................................................................................................. 313
BottomFaceNodes .................................................................................................................. 313
CircumferentialDivisions ......................................................................................................... 313
Contact1Nodes ....................................................................................................................... 313
ContactPairsNodes ................................................................................................................. 313
CoordinateSystem .................................................................................................................. 313
CrackFacesNodes .................................................................................................................... 314
CrackFrontDivisions ................................................................................................................ 314
CrackFrontNodes .................................................................................................................... 314
CrackShape ............................................................................................................................ 314
CrackSourceType .................................................................................................................... 314
FaceTopNodes ........................................................................................................................ 314
FractureAffectedZone ............................................................................................................. 315
FractureAffectedZoneHeight ................................................................................................... 315
InternalObject ........................................................................................................................ 315
LargestContourRadius ............................................................................................................ 315
Location ................................................................................................................................. 315
MajorRadius ........................................................................................................................... 315
MeshContours ........................................................................................................................ 316
MinorRadius ........................................................................................................................... 316
ProjectToNearestSurface ......................................................................................................... 316
SolutionContours ................................................................................................................... 316
Suppressed ............................................................................................................................ 316
Target1Nodes ......................................................................................................................... 316
XScaleFactor ........................................................................................................................... 317
YScaleFactor ........................................................................................................................... 317
ZScaleFactor ........................................................................................................................... 317
Criterion ....................................................................................................................................... 317
Children ................................................................................................................................. 318
Comments .............................................................................................................................. 318
DataModelObjectCategory ..................................................................................................... 318
Figures ................................................................................................................................... 318

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

Images ................................................................................................................................... 318

InternalObject ........................................................................................................................ 319
Suppressed ............................................................................................................................ 319
AddComment() ....................................................................................................................... 319
AddFigure() ............................................................................................................................ 319
AddImage(string) ................................................................................................................... 319
Delete() .................................................................................................................................. 320
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 320
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 320
CriterionConstraint ....................................................................................................................... 321
Criterion ................................................................................................................................. 321
DataModelObjectCategory ..................................................................................................... 321
InitialValue ............................................................................................................................. 321
InternalObject ........................................................................................................................ 322
LowerBound ........................................................................................................................... 322
UpperBound ........................................................................................................................... 322
CrossSection ................................................................................................................................. 322
Children ................................................................................................................................. 323
Comments .............................................................................................................................. 323
DataModelObjectCategory ..................................................................................................... 323
Figures ................................................................................................................................... 323
Images ................................................................................................................................... 323
InternalObject ........................................................................................................................ 324
AddComment() ....................................................................................................................... 324
AddFigure() ............................................................................................................................ 324
AddImage(string) ................................................................................................................... 324
Delete() .................................................................................................................................. 324
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 325
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 325
CrossSections ............................................................................................................................... 326
Children ................................................................................................................................. 327
Comments .............................................................................................................................. 327
DataModelObjectCategory ..................................................................................................... 327
Figures ................................................................................................................................... 327
Images ................................................................................................................................... 327
InternalObject ........................................................................................................................ 327
AddChannelCrossSection() ...................................................................................................... 328
AddCircularCrossSection() ....................................................................................................... 328
AddCircularTubeCrossSection() ............................................................................................... 328
AddComment() ....................................................................................................................... 328
AddFigure() ............................................................................................................................ 328
AddHatCrossSection() ............................................................................................................. 328
AddHollowRectangularCrossSection() ..................................................................................... 329
AddICrossSection() ................................................................................................................. 329
AddImage(string) ................................................................................................................... 329
AddLCrossSection() ................................................................................................................. 329
AddRectangularCrossSection() ................................................................................................ 329
AddTCrossSection() ................................................................................................................ 330
AddUserDefinedCrossSection() ............................................................................................... 330
AddZCrossSection() ................................................................................................................ 330
Delete() .................................................................................................................................. 330

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

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

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 331
NameCrossSectionsUniquely() ................................................................................................ 331
CyclicManufacturingConstraint ..................................................................................................... 331
Axis ........................................................................................................................................ 332
CoordinateSystem .................................................................................................................. 332
DataModelObjectCategory ..................................................................................................... 332
InternalObject ........................................................................................................................ 332
Location ................................................................................................................................. 333
NumberofSectors ................................................................................................................... 333
ScopingMethod ...................................................................................................................... 333
CyclicRegion ................................................................................................................................. 333
DataModelObjectCategory ..................................................................................................... 334
InternalObject ........................................................................................................................ 334
DirectMorph ................................................................................................................................. 334
Children ................................................................................................................................. 335
DataModelObjectCategory ..................................................................................................... 335
DisplacementFile .................................................................................................................... 335
InternalObject ........................................................................................................................ 336
Location ................................................................................................................................. 336
ScaleFactor ............................................................................................................................. 336
Suppressed ............................................................................................................................ 336
Clear() .................................................................................................................................... 336
Delete() .................................................................................................................................. 336
Generate() .............................................................................................................................. 337
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 337
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 337
DisplacementConstraint ............................................................................................................... 338
DataModelObjectCategory ..................................................................................................... 338
InternalObject ........................................................................................................................ 338
Location ................................................................................................................................. 338
ScopingMethod ...................................................................................................................... 339
XComponentMax .................................................................................................................... 339
YComponentMax .................................................................................................................... 339
ZComponentMax .................................................................................................................... 339
DistributedMass ........................................................................................................................... 339
DataModelObjectCategory ..................................................................................................... 340
InternalObject ........................................................................................................................ 340
MassPerUnitArea .................................................................................................................... 340
MassType ............................................................................................................................... 341
Suppressed ............................................................................................................................ 341
TotalMass ............................................................................................................................... 341
DynamicComplianceConstraint ..................................................................................................... 341
ComplianceLimit .................................................................................................................... 342
DataModelObjectCategory ..................................................................................................... 342
InternalObject ........................................................................................................................ 342
MaximumValue ...................................................................................................................... 342
MinimumValue ....................................................................................................................... 342
ElementOrientation ...................................................................................................................... 343
AxisEdgeOrientation ............................................................................................................... 343
AxisSurfaceOrientation ........................................................................................................... 344

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

BodyLocation ......................................................................................................................... 344

Children ................................................................................................................................. 344
Comments .............................................................................................................................. 344
CoordinateSystem .................................................................................................................. 344
DataModelObjectCategory ..................................................................................................... 344
EdgeLocation ......................................................................................................................... 345
Figures ................................................................................................................................... 345
Images ................................................................................................................................... 345
InternalObject ........................................................................................................................ 345
OrientationGuideDefinedBy .................................................................................................... 345
Suppressed ............................................................................................................................ 345
SurfaceLocation ...................................................................................................................... 346
AddComment() ....................................................................................................................... 346
AddFigure() ............................................................................................................................ 346
AddImage(string) ................................................................................................................... 346
Delete() .................................................................................................................................. 346
GenerateOrientations() ........................................................................................................... 347
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 347
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 347
EllipticalCrack ............................................................................................................................... 348
BottomFaceNodes .................................................................................................................. 349
CircumferentialDivisions ......................................................................................................... 349
Contact1Nodes ....................................................................................................................... 349
ContactPairsNodes ................................................................................................................. 349
CoordinateSystem .................................................................................................................. 349
CrackFacesNodes .................................................................................................................... 350
CrackFrontDivisions ................................................................................................................ 350
CrackFrontNodes .................................................................................................................... 350
CrackMeshMethod ................................................................................................................. 350
CrackShape ............................................................................................................................ 350
CrackSourceType .................................................................................................................... 350
DataModelObjectCategory ..................................................................................................... 351
FractureAffectedZone ............................................................................................................. 351
FractureAffectedZoneHeight ................................................................................................... 351
FrontElementSize .................................................................................................................... 351
GrowthRate ............................................................................................................................ 351
InternalObject ........................................................................................................................ 351
LargestContourRadius ............................................................................................................ 352
Location ................................................................................................................................. 352
MajorRadius ........................................................................................................................... 352
MeshContours ........................................................................................................................ 352
MinorRadius ........................................................................................................................... 352
SolutionContours ................................................................................................................... 352
Suppressed ............................................................................................................................ 353
Target1Nodes ......................................................................................................................... 353
TopFaceNodes ........................................................................................................................ 353
XScaleFactor ........................................................................................................................... 353
YScaleFactor ........................................................................................................................... 353
ZScaleFactor ........................................................................................................................... 353
EndRelease ................................................................................................................................... 354
Behavior ................................................................................................................................. 355

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

Children ................................................................................................................................. 355

Comments .............................................................................................................................. 355
CoordinateSystem .................................................................................................................. 355
DataModelObjectCategory ..................................................................................................... 355
EdgeLocation ......................................................................................................................... 355
Figures ................................................................................................................................... 356
Images ................................................................................................................................... 356
IndependentEdges ................................................................................................................. 356
InternalObject ........................................................................................................................ 356
RotationX ............................................................................................................................... 356
RotationY ............................................................................................................................... 356
RotationZ ............................................................................................................................... 357
Suppressed ............................................................................................................................ 357
TranslationX ........................................................................................................................... 357
TranslationY ........................................................................................................................... 357
TranslationZ ........................................................................................................................... 357
VertexLocation ....................................................................................................................... 357
AddComment() ....................................................................................................................... 358
AddFigure() ............................................................................................................................ 358
AddImage(string) ................................................................................................................... 358
Delete() .................................................................................................................................. 358
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 358
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 359
ExclusionRegion ........................................................................................................................... 359
DataModelObjectCategory ..................................................................................................... 360
InternalObject ........................................................................................................................ 360
Suppressed ............................................................................................................................ 360
CopyTo(ExclusionRegion) ........................................................................................................ 360
RenameBasedOnDefinition() ................................................................................................... 361
ExpansionSettings ........................................................................................................................ 361
Children ................................................................................................................................. 362
CleanupOptionalFiles .............................................................................................................. 362
Comments .............................................................................................................................. 362
CondensedPartExpansionType ................................................................................................ 362
DataModelObjectCategory ..................................................................................................... 363
ExpandAfterUsePassFailure ..................................................................................................... 363
Figures ................................................................................................................................... 363
GeneralMiscellaneous ............................................................................................................. 363
Images ................................................................................................................................... 363
InternalObject ........................................................................................................................ 363
NodalForces ........................................................................................................................... 364
Strain ..................................................................................................................................... 364
Stress ..................................................................................................................................... 364
Suppressed ............................................................................................................................ 364
AddComment() ....................................................................................................................... 364
AddFigure() ............................................................................................................................ 364
AddImage(string) ................................................................................................................... 365
ClearGeneratedData() ............................................................................................................. 365
Delete() .................................................................................................................................. 365
EvaluateAllResults() ................................................................................................................. 365
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 365

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

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 366

GetCompletedExpansionState(CondensedPart) ....................................................................... 366
GetExpansionState(CondensedPart) ........................................................................................ 367
PerformExpansionPass() .......................................................................................................... 367
SetExpansionState(CondensedPart, CondensedPartExpansionState) ........................................ 367
ExternalEnhancedModel ............................................................................................................... 368
Children ................................................................................................................................. 368
Comments .............................................................................................................................. 368
DataModelObjectCategory ..................................................................................................... 369
Figures ................................................................................................................................... 369
Images ................................................................................................................................... 369
InternalObject ........................................................................................................................ 369
LayerToDisplay ....................................................................................................................... 369
MaximumNumberOfLayers ..................................................................................................... 369
NonlinearEffects ..................................................................................................................... 370
Suppressed ............................................................................................................................ 370
ThermalStrainEffects ............................................................................................................... 370
Type ....................................................................................................................................... 370
AddComment() ....................................................................................................................... 370
AddFigure() ............................................................................................................................ 370
AddImage(string) ................................................................................................................... 371
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 371
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 371
RegroupToDefault() ................................................................................................................ 372
ExternalModelDataColl ................................................................................................................. 372
Children ................................................................................................................................. 373
Comments .............................................................................................................................. 373
Count ..................................................................................................................................... 373
DataModelObjectCategory ..................................................................................................... 373
Figures ................................................................................................................................... 373
Images ................................................................................................................................... 374
InternalObject ........................................................................................................................ 374
Suppressed ............................................................................................................................ 374
AddComment() ....................................................................................................................... 374
AddFigure() ............................................................................................................................ 374
AddImage(string) ................................................................................................................... 374
Delete() .................................................................................................................................. 375
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 375
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 375
ExtrusionManufacturingConstraint ............................................................................................... 376
Axis ........................................................................................................................................ 376
CoordinateSystem .................................................................................................................. 377
DataModelObjectCategory ..................................................................................................... 377
InternalObject ........................................................................................................................ 377
Location ................................................................................................................................. 377
ScopingMethod ...................................................................................................................... 377
FatigueCombination ..................................................................................................................... 377
Children ................................................................................................................................. 378
Comments .............................................................................................................................. 378
DataModelObjectCategory ..................................................................................................... 378
Images ................................................................................................................................... 379

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

InternalObject ........................................................................................................................ 379

AddComment() ....................................................................................................................... 379
AddDamage() ......................................................................................................................... 379
AddImage(string) ................................................................................................................... 379
Delete() .................................................................................................................................. 380
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 380
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 380
FatigueTool .................................................................................................................................. 381
AnalysisType ........................................................................................................................... 382
BinSize ................................................................................................................................... 382
Children ................................................................................................................................. 382
Comments .............................................................................................................................. 382
CustomUnitsName ................................................................................................................. 383
DataModelObjectCategory ..................................................................................................... 383
DisplayTime ............................................................................................................................ 383
ExposureDuration ................................................................................................................... 383
FatigueStrengthFactor ............................................................................................................ 383
Frequency .............................................................................................................................. 383
FrequencySelection ................................................................................................................ 384
HistoryDataLocation ............................................................................................................... 384
Images ................................................................................................................................... 384
InfiniteLife .............................................................................................................................. 384
InternalObject ........................................................................................................................ 384
LoadingRatio .......................................................................................................................... 384
LoadingType ........................................................................................................................... 385
MaximumDataPointsToPlot ..................................................................................................... 385
MeanStressTheory .................................................................................................................. 385
MethodSelection .................................................................................................................... 385
OneCycleIsEqualTo ................................................................................................................. 385
ResultsInput ........................................................................................................................... 385
ScaleFactor ............................................................................................................................. 386
StressComponent ................................................................................................................... 386
UnitsName ............................................................................................................................. 386
UseQuickRainflowCounting .................................................................................................... 386
AddBiaxialityIndication() ......................................................................................................... 386
AddComment() ....................................................................................................................... 386
AddDamage() ......................................................................................................................... 387
AddDamageMatrix() ............................................................................................................... 387
AddEquivalentAlternativeStress() ............................................................................................ 387
AddFatigueSensitivity() ........................................................................................................... 387
AddHysteresis() ....................................................................................................................... 387
AddImage(string) ................................................................................................................... 387
AddLife() ................................................................................................................................ 388
AddRainflowMatrix() ............................................................................................................... 388
AddSafetyFactor() ................................................................................................................... 388
Delete() .................................................................................................................................. 388
EvaluateAllResults() ................................................................................................................. 388
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 389
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 389
FeatureDetection .......................................................................................................................... 390
Children ................................................................................................................................. 390

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

Comments .............................................................................................................................. 391

DataModelObjectCategory ..................................................................................................... 391
Definition ............................................................................................................................... 391
Images ................................................................................................................................... 391
InternalObject ........................................................................................................................ 391
Location ................................................................................................................................. 391
NamedSelection ..................................................................................................................... 392
ScopingMethod ...................................................................................................................... 392
AddComment() ....................................................................................................................... 392
AddImage(string) ................................................................................................................... 392
ClearGeneratedData() ............................................................................................................. 392
Delete() .................................................................................................................................. 393
DetectFeatures() ..................................................................................................................... 393
EvaluateAllResults() ................................................................................................................. 393
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 393
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 393
FeatureDetectionDefinition .......................................................................................................... 394
FeatureDetectionCount .......................................................................................................... 395
AddFeatureDetection(string, int, int, int, double, double, double, double, int) ............................. 396
DeleteFeatureDetection(uint) ................................................................................................. 396
ExecuteDetectFeatures() ......................................................................................................... 397
Export(string) ......................................................................................................................... 397
GetFeatureCriteriaAngle(uint) ................................................................................................. 397
GetFeatureCriteriaMaxBound(uint) .......................................................................................... 397
GetFeatureCriteriaMinBound(uint) .......................................................................................... 398
GetFeatureCriteriaValue(uint) .................................................................................................. 398
GetFeatureDetectionCriteria(uint) ........................................................................................... 398
GetFeatureDetectionName(uint) ............................................................................................. 399
GetFeatureDetectionOperator(uint) ........................................................................................ 399
GetFeatureDetectionTreatment(uint) ...................................................................................... 399
GetFeatureDetectionType(uint) ............................................................................................... 400
Import(string) ......................................................................................................................... 400
SetFeatureCriteriaAngle(uint, double) ...................................................................................... 400
SetFeatureCriteriaMaxBound(uint, double) .............................................................................. 400
SetFeatureCriteriaMinBound(uint, double) .............................................................................. 401
SetFeatureCriteriaValue(uint, double) ...................................................................................... 401
SetFeatureDetectionCriteria(uint, FeatureDetectionCriteria) ..................................................... 402
SetFeatureDetectionName(uint, string) ................................................................................... 402
SetFeatureDetectionOperator(uint, FeatureDetectionOperator) ............................................... 402
SetFeatureDetectionOptions(bool, bool, bool) ......................................................................... 403
SetFeatureDetectionTreatment(uint, FeatureDetectionTreatment) ........................................... 403
SetFeatureDetectionType(uint, FeatureDetectionType) ............................................................ 404
Figure ........................................................................................................................................... 404
Children ................................................................................................................................. 405
Comments .............................................................................................................................. 405
DataModelObjectCategory ..................................................................................................... 405
InternalObject ........................................................................................................................ 405
Text ........................................................................................................................................ 405
AddComment() ....................................................................................................................... 405
Delete() .................................................................................................................................. 406
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 406

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

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 406

Fracture ........................................................................................................................................ 407
Children ................................................................................................................................. 408
Comments .............................................................................................................................. 408
DataModelObjectCategory ..................................................................................................... 408
Figures ................................................................................................................................... 408
Images ................................................................................................................................... 408
InternalObject ........................................................................................................................ 408
RemeshHexDominantToTetrahedral ........................................................................................ 409
AddArbitraryCrack() ................................................................................................................ 409
AddComment() ....................................................................................................................... 409
AddContactDebonding() ........................................................................................................ 409
AddCrack() ***OBSOLETE*** Use the method AddArbitraryCrack or AddSemiEllipticalCrack in-
stead. ..................................................................................................................................... 409
AddEllipticalCrack() ................................................................................................................. 409
AddFigure() ............................................................................................................................ 410
AddImage(string) ................................................................................................................... 410
AddInterfaceDelamination() .................................................................................................... 410
AddPreMeshedCrack() ............................................................................................................ 410
AddRingCrack() ....................................................................................................................... 410
AddSemiEllipticalCrack() ......................................................................................................... 411
AddSMARTCrackGrowth() ....................................................................................................... 411
Delete() .................................................................................................................................. 411
GenerateAllCrackMesh() ......................................................................................................... 411
GenerateAllInterfaceDelamination() ........................................................................................ 411
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 411
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 412
GeneralAxisymmetric .................................................................................................................... 412
Axis ........................................................................................................................................ 413
Children ................................................................................................................................. 413
Comments .............................................................................................................................. 413
CoordinateSystem .................................................................................................................. 414
DataModelObjectCategory ..................................................................................................... 414
EndPlane ................................................................................................................................ 414
Figures ................................................................................................................................... 414
Images ................................................................................................................................... 414
InternalObject ........................................................................................................................ 414
Location ................................................................................................................................. 415
NodalPlanes ........................................................................................................................... 415
NodalPlanesVisible ................................................................................................................. 415
StartPlane ............................................................................................................................... 415
Suppressed ............................................................................................................................ 415
AddComment() ....................................................................................................................... 415
AddFigure() ............................................................................................................................ 416
AddImage(string) ................................................................................................................... 416
Delete() .................................................................................................................................. 416
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 416
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 417
GenericCrack ................................................................................................................................ 417
Children ................................................................................................................................. 418
Comments .............................................................................................................................. 418

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

DataModelObjectCategory ..................................................................................................... 418

Figures ................................................................................................................................... 418
Images ................................................................................................................................... 418
InternalObject ........................................................................................................................ 419
AddCommandSnippet() .......................................................................................................... 419
AddComment() ....................................................................................................................... 419
AddFigure() ............................................................................................................................ 419
AddImage(string) ................................................................................................................... 419
Delete() .................................................................................................................................. 420
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 420
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 420
GenericDelamination .................................................................................................................... 421
Children ................................................................................................................................. 421
Comments .............................................................................................................................. 422
DataModelObjectCategory ..................................................................................................... 422
Figures ................................................................................................................................... 422
Images ................................................................................................................................... 422
InternalObject ........................................................................................................................ 422
AddCommandSnippet() .......................................................................................................... 422
AddComment() ....................................................................................................................... 423
AddFigure() ............................................................................................................................ 423
AddImage(string) ................................................................................................................... 423
Delete() .................................................................................................................................. 423
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 423
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 424
GenericPointMass ......................................................................................................................... 424
Children ................................................................................................................................. 425
Comments .............................................................................................................................. 425
DataModelObjectCategory ..................................................................................................... 425
Figures ................................................................................................................................... 425
Images ................................................................................................................................... 426
InternalObject ........................................................................................................................ 426
IsDistributedMass ................................................................................................................... 426
Location ................................................................................................................................. 426
RemotePoint .......................................................................................................................... 426
AddCommandSnippet() .......................................................................................................... 426
AddComment() ....................................................................................................................... 427
AddFigure() ............................................................................................................................ 427
AddImage(string) ................................................................................................................... 427
Delete() .................................................................................................................................. 427
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 427
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 428
Geometry ..................................................................................................................................... 428
ActiveBodies ........................................................................................................................... 432
AnalysisType ........................................................................................................................... 432
AssignMaterialOnUpdate ........................................................................................................ 432
AttachFileViaTempFile ............................................................................................................ 433
AttributeKey ........................................................................................................................... 433
Attributes ............................................................................................................................... 433
Average .................................................................................................................................. 433
Bodies .................................................................................................................................... 433

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

CanChangeCADUnits .............................................................................................................. 433

Children ................................................................................................................................. 434
Comments .............................................................................................................................. 434
ComparePartsOnUpdate ......................................................................................................... 434
ComparePartsTolerance .......................................................................................................... 434
DataModelObjectCategory ..................................................................................................... 434
DecomposeDisjointGeometry ................................................................................................. 434
DisplayStyle ............................................................................................................................ 435
ElementControl ...................................................................................................................... 435
Elements ................................................................................................................................ 435
EnclosureAndSymmetryProcessing ......................................................................................... 435
EndPlaneRotationAboutX ....................................................................................................... 435
EndPlaneRotationAboutY ....................................................................................................... 435
FiberLength ............................................................................................................................ 436
Figures ................................................................................................................................... 436
GeometryPreferencesReadOnly .............................................................................................. 436
Images ................................................................................................................................... 436
ImportCoordinateSystems ...................................................................................................... 436
InternalObject ........................................................................................................................ 436
LengthUnit ............................................................................................................................. 437
LengthX ................................................................................................................................. 437
LengthY ................................................................................................................................. 437
LengthZ ................................................................................................................................. 437
LineBodies .............................................................................................................................. 437
Mass ....................................................................................................................................... 437
MaterialProperties .................................................................................................................. 438
Maximum ............................................................................................................................... 438
MeshMetric ............................................................................................................................ 438
MeshVolume .......................................................................................................................... 438
Minimum ............................................................................................................................... 438
MixedImportResolution .......................................................................................................... 438
Model2DBehavior ................................................................................................................... 439
NamedSelectionKey ............................................................................................................... 439
NamedSelections .................................................................................................................... 439
Nodes ..................................................................................................................................... 439
ParameterKey ......................................................................................................................... 439
Parameters ............................................................................................................................. 439
PercentGeometryAssociativityTolerance .................................................................................. 440
ReaderModeSavesUpdatedFile ................................................................................................ 440
ScaleFactorValue ..................................................................................................................... 440
SheetSurfaceArea ................................................................................................................... 440
SmartCADUpdate ................................................................................................................... 440
SolidBodies ............................................................................................................................ 440
Source .................................................................................................................................... 441
StandardDeviation .................................................................................................................. 441
SurfaceArea ............................................................................................................................ 441
SurfaceBodies ......................................................................................................................... 441
TemporaryDirectory ................................................................................................................ 441
Tolerance2D ........................................................................................................................... 441
Type ....................................................................................................................................... 442
UseAssociativity ...................................................................................................................... 442

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

UseInstances .......................................................................................................................... 442

Volume ................................................................................................................................... 442
XCentroid ............................................................................................................................... 442
YCentroid ............................................................................................................................... 442
ZCentroid ............................................................................................................................... 443
AddComment() ....................................................................................................................... 443
AddDistributedMass() ............................................................................................................. 443
AddElementOrientation() ........................................................................................................ 443
AddFigure() ............................................................................................................................ 443
AddImage(string) ................................................................................................................... 443
AddLayeredSection() .............................................................................................................. 444
AddPointMass() ...................................................................................................................... 444
AddSurfaceCoating() .............................................................................................................. 444
AddThermalPointMass() .......................................................................................................... 444
AddThickness() ....................................................................................................................... 444
FreezeMeshOnAllParts() .......................................................................................................... 445
GetBody(IBaseGeoBody) ......................................................................................................... 445
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 445
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 445
GetPart(IBaseGeoPart) ............................................................................................................ 446
InvertSuppressedBodySet() ..................................................................................................... 446
RefreshInvalidReferenceData() ................................................................................................ 446
RescopeFromGeomAssocData(bool) ....................................................................................... 447
RescopeGivenObjectsFromGeomAssocData(IAnsUINTColl) ...................................................... 447
ResetBodyColors() .................................................................................................................. 447
RunGeometryAssociativityQueries() ........................................................................................ 447
UnfreezeMeshOnAllParts() ...................................................................................................... 447
UnsuppressAllBodies() ............................................................................................................ 448
UpdateGeometryFromSource() ............................................................................................... 448
GeometryFileContainer ................................................................................................................. 448
Children ................................................................................................................................. 449
Comments .............................................................................................................................. 449
DataModelObjectCategory ..................................................................................................... 449
Figures ................................................................................................................................... 449
Images ................................................................................................................................... 449
InternalObject ........................................................................................................................ 450
LengthUnits ............................................................................................................................ 450
ShowAlways ........................................................................................................................... 450
Statistics ................................................................................................................................. 450
Suppressed ............................................................................................................................ 450
AddComment() ....................................................................................................................... 450
AddFigure() ............................................................................................................................ 451
AddImage(string) ................................................................................................................... 451
Delete() .................................................................................................................................. 451
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 451
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 452
ImportSTL() ............................................................................................................................ 452
GeometryImport .......................................................................................................................... 452
Children ................................................................................................................................. 453
Comments .............................................................................................................................. 453
DataModelObjectCategory ..................................................................................................... 454

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

Figures ................................................................................................................................... 454

Images ................................................................................................................................... 454
InternalObject ........................................................................................................................ 454
Parts ....................................................................................................................................... 454
AddComment() ....................................................................................................................... 454
AddFigure() ............................................................................................................................ 455
AddImage(string) ................................................................................................................... 455
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 455
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 456
GetFormat() ............................................................................................................................ 456
GetGeometryURI() .................................................................................................................. 456
GetPreferences() ..................................................................................................................... 456
Import(string, Format, GeometryImportPreferences) ................................................................ 457
GeometryImportGroup ................................................................................................................. 457
Children ................................................................................................................................. 458
Comments .............................................................................................................................. 458
Count ..................................................................................................................................... 458
DataModelObjectCategory ..................................................................................................... 458
Figures ................................................................................................................................... 459
Images ................................................................................................................................... 459
InternalObject ........................................................................................................................ 459
Item(int) ................................................................................................................................. 459
AddComment() ....................................................................................................................... 459
AddFigure() ............................................................................................................................ 459
AddGeometryImport() ............................................................................................................ 460
AddImage(string) ................................................................................................................... 460
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 460
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 461
GlobalVonMisesStressConstraint ................................................................................................... 461
DataModelObjectCategory ..................................................................................................... 462
InternalObject ........................................................................................................................ 462
Maximum ............................................................................................................................... 462
ScopingMethod ...................................................................................................................... 462
StressType .............................................................................................................................. 462
HatCrossSection ........................................................................................................................... 462
Area ....................................................................................................................................... 463
DataModelObjectCategory ..................................................................................................... 463
InternalObject ........................................................................................................................ 464
IYY ......................................................................................................................................... 464
IZZ ......................................................................................................................................... 464
Thick1 .................................................................................................................................... 464
Thick2 .................................................................................................................................... 464
Thick3 .................................................................................................................................... 464
Thick4 .................................................................................................................................... 465
Thick5 .................................................................................................................................... 465
Width1 ................................................................................................................................... 465
Width2 ................................................................................................................................... 465
Width3 ................................................................................................................................... 465
Width4 ................................................................................................................................... 465
HollowRectangularCrossSection ................................................................................................... 466
Area ....................................................................................................................................... 466

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

DataModelObjectCategory ..................................................................................................... 467

InternalObject ........................................................................................................................ 467
IYY ......................................................................................................................................... 467
IZZ ......................................................................................................................................... 467
Thick1 .................................................................................................................................... 467
Thick2 .................................................................................................................................... 467
Thick3 .................................................................................................................................... 468
Thick4 .................................................................................................................................... 468
Width1 ................................................................................................................................... 468
Width2 ................................................................................................................................... 468
HousingConstraint ........................................................................................................................ 468
DataModelObjectCategory ..................................................................................................... 469
HousingLocation .................................................................................................................... 469
HousingScopingMethod ......................................................................................................... 469
InternalObject ........................................................................................................................ 470
Location ................................................................................................................................. 470
ScopingMethod ...................................................................................................................... 470
ICrossSection ................................................................................................................................ 470
Area ....................................................................................................................................... 471
DataModelObjectCategory ..................................................................................................... 471
InternalObject ........................................................................................................................ 471
IYY ......................................................................................................................................... 471
IZZ ......................................................................................................................................... 472
Thick1 .................................................................................................................................... 472
Thick2 .................................................................................................................................... 472
Thick3 .................................................................................................................................... 472
Width1 ................................................................................................................................... 472
Width2 ................................................................................................................................... 472
Width3 ................................................................................................................................... 473
Image ........................................................................................................................................... 473
Children ................................................................................................................................. 473
Comments .............................................................................................................................. 473
DataModelObjectCategory ..................................................................................................... 474
Images ................................................................................................................................... 474
InternalObject ........................................................................................................................ 474
AddComment() ....................................................................................................................... 474
AddImage(string) ................................................................................................................... 474
Delete() .................................................................................................................................. 475
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 475
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 475
ImagePlane .................................................................................................................................. 476
Children ................................................................................................................................. 477
Comments .............................................................................................................................. 477
CoordinateSystem .................................................................................................................. 477
CoordinateSystemVisible ........................................................................................................ 477
DataModelObjectCategory ..................................................................................................... 478
FlipHorizontally ...................................................................................................................... 478
FlipVertically ........................................................................................................................... 478
Height .................................................................................................................................... 478
ImageFilePath ......................................................................................................................... 478
Images ................................................................................................................................... 478

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

InternalObject ........................................................................................................................ 479

PixelHeight ............................................................................................................................. 479
PixelWidth .............................................................................................................................. 479
ShowAlways ........................................................................................................................... 479
Translucency .......................................................................................................................... 479
Width ..................................................................................................................................... 479
AddComment() ....................................................................................................................... 480
Delete() .................................................................................................................................. 480
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 480
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 480
Import(string) ......................................................................................................................... 481
ImportedBoltPretensions .............................................................................................................. 481
DataModelObjectCategory ..................................................................................................... 482
InternalObject ........................................................................................................................ 482
ImportedCondensedPart .............................................................................................................. 482
ActualNodeOffset ................................................................................................................... 486
CondensedPartFileName ........................................................................................................ 486
CondensedPartUnitSystem ..................................................................................................... 486
CoordinateSystem .................................................................................................................. 486
DataModelObjectCategory ..................................................................................................... 486
ImportFileFormat .................................................................................................................... 486
ImportStatus .......................................................................................................................... 487
InternalObject ........................................................................................................................ 487
NodeOffset ............................................................................................................................. 487
CreateJointFromNodeIds(IEnumerable<int>) .......................................................................... 487
CreateJoints(IEnumerable<int>) .............................................................................................. 487
CreateNodalNamedSelectionFromNodeIds(IEnumerable<int>) ............................................... 488
CreateNodalNamedSelections(IEnumerable<int>) ................................................................... 488
CreateRemotePointFromNodeIds(IEnumerable<int>) .............................................................. 488
CreateRemotePoints(IEnumerable<int>) ................................................................................. 489
GetOriginalNodeCoordinates() ................................................................................................ 489
GetTransformedNodeCoordinates() ......................................................................................... 489
ImportCondensedPart() .......................................................................................................... 489
ReadInterfaceData() ................................................................................................................ 489
UpdateNodeLocation(int, Quantity, Quantity, Quantity, Quantity, Quantity, Quantity) ................ 490
ImportedConstraintEquations ....................................................................................................... 490
DataModelObjectCategory ..................................................................................................... 491
InternalObject ........................................................................................................................ 491
ImportedContacts ........................................................................................................................ 492
DataModelObjectCategory ..................................................................................................... 492
InternalObject ........................................................................................................................ 493
ImportedCoordinateSystems ........................................................................................................ 493
DataModelObjectCategory ..................................................................................................... 494
InternalObject ........................................................................................................................ 494
ImportedElementOrientations ...................................................................................................... 494
DataModelObjectCategory ..................................................................................................... 495
InternalObject ........................................................................................................................ 495
ImportedFlexibleRemoteConnectors ............................................................................................. 495
DataModelObjectCategory ..................................................................................................... 496
InternalObject ........................................................................................................................ 496
ImportedLayeredSection .............................................................................................................. 496

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

DataModelObjectCategory ..................................................................................................... 497

InternalObject ........................................................................................................................ 498
ImportedNodalOrientations .......................................................................................................... 498
DataModelObjectCategory ..................................................................................................... 499
InternalObject ........................................................................................................................ 499
ImportedObject ............................................................................................................................ 499
Active ..................................................................................................................................... 499
InternalObject ........................................................................................................................ 499
GetPropertyNames() ............................................................................................................... 500
GetPropertyValueAsString(string) ........................................................................................... 500
SetPropertyValue(string, object) .............................................................................................. 500
ImportedPlies ............................................................................................................................... 500
DataModelObjectCategory ..................................................................................................... 502
InternalObject ........................................................................................................................ 502
ImportedPliesCollection ............................................................................................................... 502
Children ................................................................................................................................. 502
Comments .............................................................................................................................. 503
DataModelObjectCategory ..................................................................................................... 503
Figures ................................................................................................................................... 503
Images ................................................................................................................................... 503
InternalObject ........................................................................................................................ 503
AddComment() ....................................................................................................................... 503
AddFigure() ............................................................................................................................ 504
AddImage(string) ................................................................................................................... 504
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 504
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 505
ImportedPointMasses ................................................................................................................... 505
DataModelObjectCategory ..................................................................................................... 506
InternalObject ........................................................................................................................ 506
ImportedPremeshedBoltPretensions ............................................................................................. 506
DataModelObjectCategory ..................................................................................................... 507
InternalObject ........................................................................................................................ 507
ImportedRigidRemoteConnectors ................................................................................................. 507
DataModelObjectCategory ..................................................................................................... 508
InternalObject ........................................................................................................................ 508
ImportedShellThicknesses ............................................................................................................ 508
DataModelObjectCategory ..................................................................................................... 509
InternalObject ........................................................................................................................ 509
ImportedSpringConnectors .......................................................................................................... 510
DataModelObjectCategory ..................................................................................................... 510
InternalObject ........................................................................................................................ 511
ImportedStresses .......................................................................................................................... 511
DataModelObjectCategory ..................................................................................................... 512
InternalObject ........................................................................................................................ 512
InitialCondition ............................................................................................................................. 512
Children ................................................................................................................................. 514
Comments .............................................................................................................................. 514
ContactStatus ......................................................................................................................... 514
CoordinateSystem .................................................................................................................. 515
DataModelObjectCategory ..................................................................................................... 515
DefineBy ................................................................................................................................ 515

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

Direction ................................................................................................................................ 515

DropDirection ........................................................................................................................ 515
DropHeight ............................................................................................................................ 515
DropTestDefineBy ................................................................................................................... 516
ExplicitPreStressTime .............................................................................................................. 516
Figures ................................................................................................................................... 516
Images ................................................................................................................................... 516
ImpactVelocity ........................................................................................................................ 516
InitialEnvironment .................................................................................................................. 516
InitialTemperature .................................................................................................................. 517
InitialTemperatureValue .......................................................................................................... 517
InputType ............................................................................................................................... 517
InternalObject ........................................................................................................................ 517
LoadControl ........................................................................................................................... 517
Location ................................................................................................................................. 517
ModalEnvironmentHarmonicIC ***OBSOLETE*** Use 'ModalICEnvironment' property in-
stead. ..................................................................................................................................... 518
ModalEnvironmentPSDIC ***OBSOLETE*** Use 'ModalICEnvironment' property instead. .......... 518
ModalEnvironmentRSIC ***OBSOLETE*** Use 'ModalICEnvironment' property instead. ............ 518
ModalEnvironmentTransientMSUPIC ***OBSOLETE*** Use 'ModalICEnvironment' property in-
stead. ..................................................................................................................................... 518
ModalICEnvironment .............................................................................................................. 518
Mode ..................................................................................................................................... 519
NewtonRaphsonOption .......................................................................................................... 519
PressureInitialization ............................................................................................................... 519
PreStressDefineBy ................................................................................................................... 519
PreStressEnvironmentHarmonicIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 519
PreStressEnvironmentHarmonicMSUPModal ........................................................................... 519
PreStressEnvironmentModalIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 520
PreStressEnvironmentTransientIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 520
PreStressEnvironmentTransientMSUPModal ............................................................................ 520
PreStressICEnvironment .......................................................................................................... 520
PreStressLoadStep .................................................................................................................. 520
PreStressTime ......................................................................................................................... 520
ReferenceTemperature ............................................................................................................ 521
ReportedLoadStep .................................................................................................................. 521
ReportedSubStep ................................................................................................................... 521
ReportedTime ........................................................................................................................ 521
Suppressed ............................................................................................................................ 521
Time ....................................................................................................................................... 521
TimeStepFactor ...................................................................................................................... 522
TotalMagnitude ...................................................................................................................... 522
XComponent .......................................................................................................................... 522
YComponent .......................................................................................................................... 522
ZComponent .......................................................................................................................... 522
AddCommandSnippet() .......................................................................................................... 522
AddComment() ....................................................................................................................... 523
AddFigure() ............................................................................................................................ 523

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

AddImage(string) ................................................................................................................... 523

Delete() .................................................................................................................................. 523
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 523
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 524
InitialConditions ........................................................................................................................... 524
Children ................................................................................................................................. 525
Comments .............................................................................................................................. 525
DataModelObjectCategory ..................................................................................................... 525
Figures ................................................................................................................................... 526
Images ................................................................................................................................... 526
InternalObject ........................................................................................................................ 526
AddComment() ....................................................................................................................... 526
AddFigure() ............................................................................................................................ 526
AddImage(string) ................................................................................................................... 526
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 527
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 527
InsertAngularVelocity() ........................................................................................................... 528
InsertDropHeight() ................................................................................................................. 528
InsertVelocity() ....................................................................................................................... 528
InterfaceDelamination .................................................................................................................. 528
AutomaticTimeStepping ......................................................................................................... 529
CriticalRate ............................................................................................................................. 529
DataModelObjectCategory ..................................................................................................... 529
DistanceTolerance .................................................................................................................. 530
FailureCriteriaOption .............................................................................................................. 530
GenerationMethod ................................................................................................................. 530
InitialCrack ............................................................................................................................. 530
InitialTimeStep ....................................................................................................................... 530
InternalObject ........................................................................................................................ 530
MatchControl ......................................................................................................................... 531
Material .................................................................................................................................. 531
MaximumTimeStep ................................................................................................................ 531
Method .................................................................................................................................. 531
MinimumTimeStep ................................................................................................................. 531
SourceLocation ....................................................................................................................... 531
Suppressed ............................................................................................................................ 532
TargetLocation ....................................................................................................................... 532
ToleranceType ........................................................................................................................ 532
Type ....................................................................................................................................... 532
JointBushingWorksheet ................................................................................................................ 532
GetBushingDampingPerThetaUnitX(int) .................................................................................. 534
GetBushingDampingPerThetaUnitY(int) .................................................................................. 534
GetBushingDampingPerThetaUnitZ(int) .................................................................................. 534
GetBushingDampingPerUnitX(int) .......................................................................................... 534
GetBushingDampingPerUnitY(int) ........................................................................................... 535
GetBushingDampingPerUnitZ(int) ........................................................................................... 535
GetBushingStiffnessPerThetaUnitX(int) ................................................................................... 535
GetBushingStiffnessPerThetaUnitY(int) ................................................................................... 536
GetBushingStiffnessPerThetaUnitZ(int) ................................................................................... 536
GetBushingStiffnessPerUnitX(int) ............................................................................................ 536
GetBushingStiffnessPerUnitY(int) ............................................................................................ 536

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

GetBushingStiffnessPerUnitZ(int) ............................................................................................ 537

SetBushingDampingPerThetaUnitX(int, double) ...................................................................... 537
SetBushingDampingPerThetaUnitY(int, double) ...................................................................... 537
SetBushingDampingPerThetaUnitZ(int, double) ...................................................................... 538
SetBushingDampingPerUnitX(int, double) ............................................................................... 538
SetBushingDampingPerUnitY(int, double) ............................................................................... 538
SetBushingDampingPerUnitZ(int, double) ............................................................................... 539
SetBushingStiffnessPerThetaUnitX(int, double) ........................................................................ 539
SetBushingStiffnessPerThetaUnitY(int, double) ........................................................................ 540
SetBushingStiffnessPerThetaUnitZ(int, double) ........................................................................ 540
SetBushingStiffnessPerUnitX(int, double) ................................................................................ 540
SetBushingStiffnessPerUnitY(int, double) ................................................................................. 541
SetBushingStiffnessPerUnitZ(int, double) ................................................................................ 541
LayeredSection ............................................................................................................................. 541
Children ................................................................................................................................. 542
Comments .............................................................................................................................. 543
CoordinateSystem .................................................................................................................. 543
DataModelObjectCategory ..................................................................................................... 543
Figures ................................................................................................................................... 543
Images ................................................................................................................................... 543
InternalObject ........................................................................................................................ 543
LayeredSectionMembraneOffset ............................................................................................. 544
Layers ..................................................................................................................................... 544
LayerToDisplay ....................................................................................................................... 544
Location ................................................................................................................................. 544
NonlinearEffects ..................................................................................................................... 544
OffsetType .............................................................................................................................. 544
Suppressed ............................................................................................................................ 545
ThermalStrainEffects ............................................................................................................... 545
TotalMass ............................................................................................................................... 545
TotalThickness ........................................................................................................................ 545
AddComment() ....................................................................................................................... 545
AddFigure() ............................................................................................................................ 545
AddImage(string) ................................................................................................................... 546
Delete() .................................................................................................................................. 546
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 546
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 546
LayeredSectionWorksheet ............................................................................................................ 547
RowCount .............................................................................................................................. 548
AddThicknessLayer(string, double, double) .............................................................................. 548
DeleteRow(int) ....................................................................................................................... 549
GetAngle(int) .......................................................................................................................... 549
GetMaterial(int) ...................................................................................................................... 549
GetThickness(int) .................................................................................................................... 549
InsertThicknessLayerAbove(string, double, double, int) ............................................................ 550
InsertThicknessLayerBelow(string, double, double, int) ............................................................. 550
SetAngle(int, double) .............................................................................................................. 551
SetMaterial(int, string) ............................................................................................................. 551
SetThickness(int, double) ........................................................................................................ 552
LCrossSection ............................................................................................................................... 552
Area ....................................................................................................................................... 553

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

DataModelObjectCategory ..................................................................................................... 553

InternalObject ........................................................................................................................ 553
IYY ......................................................................................................................................... 553
IZZ ......................................................................................................................................... 553
Thick1 .................................................................................................................................... 554
Thick2 .................................................................................................................................... 554
Width1 ................................................................................................................................... 554
Width2 ................................................................................................................................... 554
LocalVonMisesStressConstraint ..................................................................................................... 554
DataModelObjectCategory ..................................................................................................... 555
InternalObject ........................................................................................................................ 555
Location ................................................................................................................................. 555
Maximum ............................................................................................................................... 555
ScopingMethod ...................................................................................................................... 556
ManufacturingConstraint .............................................................................................................. 556
Children ................................................................................................................................. 556
DataModelObjectCategory ..................................................................................................... 556
InternalObject ........................................................................................................................ 557
Selection ................................................................................................................................ 557
Suppressed ............................................................................................................................ 557
Delete() .................................................................................................................................. 557
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 557
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 558
RenameBasedOnDefinition() ................................................................................................... 558
MappingValidation ....................................................................................................................... 558
ActiveSequence ...................................................................................................................... 560
ActiveSequenceByValue .......................................................................................................... 560
BoundingTolerance ................................................................................................................ 560
Children ................................................................................................................................. 560
Comments .............................................................................................................................. 560
ComplexComponent .............................................................................................................. 560
Component ............................................................................................................................ 561
DataModelObjectCategory ..................................................................................................... 561
DefineActiveSequenceBy ........................................................................................................ 561
Display ................................................................................................................................... 561
DisplayDataType ..................................................................................................................... 561
Figures ................................................................................................................................... 561
FileIdentifierIndex ................................................................................................................... 562
Images ................................................................................................................................... 562
InternalObject ........................................................................................................................ 562
IsolineThickness ..................................................................................................................... 562
IsolineType ............................................................................................................................. 562
Layer ...................................................................................................................................... 562
LegendDivisions ..................................................................................................................... 563
Scale ...................................................................................................................................... 563
ShellFace ................................................................................................................................ 563
Type ....................................................................................................................................... 563
AddComment() ....................................................................................................................... 563
AddFigure() ............................................................................................................................ 563
AddImage(string) ................................................................................................................... 564
Delete() .................................................................................................................................. 564

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

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

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 564
MassConstraint ............................................................................................................................. 565
DataModelObjectCategory ..................................................................................................... 566
DefineBy ................................................................................................................................ 566
InternalObject ........................................................................................................................ 566
Location ................................................................................................................................. 566
MaximumAbsoluteValue ......................................................................................................... 566
MinimumAbsoluteValue ......................................................................................................... 566
PercentageToRetain ................................................................................................................ 567
PercentageToRetainMax ......................................................................................................... 567
PercentageToRetainMin .......................................................................................................... 567
ScopingMethod ...................................................................................................................... 567
Selection ................................................................................................................................ 567
Material ........................................................................................................................................ 567
AssignedBodies ...................................................................................................................... 568
Children ................................................................................................................................. 568
Comments .............................................................................................................................. 569
DataModelObjectCategory ..................................................................................................... 569
Figures ................................................................................................................................... 569
Images ................................................................................................................................... 569
InternalObject ........................................................................................................................ 569
AddComment() ....................................................................................................................... 569
AddFigure() ............................................................................................................................ 570
AddImage(string) ................................................................................................................... 570
AddMaterialAssignment() ....................................................................................................... 570
CreateMaterialAssignment() ***OBSOLETE*** Use 'AddMaterialAssignment' instead ................ 570
GetAsDictionary() ................................................................................................................... 570
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 571
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 571
MaterialAssignment ...................................................................................................................... 571
Children ................................................................................................................................. 572
Comments .............................................................................................................................. 573
DataModelObjectCategory ..................................................................................................... 573
FieldCoordinateSystem ........................................................................................................... 573
Figures ................................................................................................................................... 573
Images ................................................................................................................................... 573
InternalObject ........................................................................................................................ 573
Location ................................................................................................................................. 574
Material .................................................................................................................................. 574
MaterialName ***OBSOLETE*** Use 'Material' property instead. ............................................... 574
NonlinearEffects ..................................................................................................................... 574
ReferenceTemperatureValue ................................................................................................... 574
Suppressed ............................................................................................................................ 574
ThermalStrainEffects ............................................................................................................... 575
UseReferenceTemperatureByBody .......................................................................................... 575
AddCommandSnippet() .......................................................................................................... 575
AddComment() ....................................................................................................................... 575
AddFigure() ............................................................................................................................ 575
AddImage(string) ................................................................................................................... 575
CreateMaterialPlot() ................................................................................................................ 576

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

Delete() .................................................................................................................................. 576

GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 576
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 576
MaterialPlot .................................................................................................................................. 577
Children ................................................................................................................................. 578
DataModelObjectCategory ..................................................................................................... 578
InternalObject ........................................................................................................................ 578
Location ................................................................................................................................. 578
MaterialProperty ..................................................................................................................... 578
MaterialPropertyComponent .................................................................................................. 578
Suppressed ............................................................................................................................ 579
Clear() .................................................................................................................................... 579
Delete() .................................................................................................................................. 579
Generate() .............................................................................................................................. 579
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 579
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 580
Materials ...................................................................................................................................... 580
Children ................................................................................................................................. 581
Comments .............................................................................................................................. 581
DataModelObjectCategory ..................................................................................................... 581
Figures ................................................................................................................................... 581
Images ................................................................................................................................... 582
InternalObject ........................................................................................................................ 582
MaterialAssignments .............................................................................................................. 582
MaterialCount ......................................................................................................................... 582
AddComment() ....................................................................................................................... 582
AddFigure() ............................................................................................................................ 582
AddImage(string) ................................................................................................................... 583
AddMaterialAssignment() ....................................................................................................... 583
AddMaterialCombination() ..................................................................................................... 583
AddMaterialPlot() ................................................................................................................... 583
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 583
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 584
RefreshMaterials() ................................................................................................................... 584
MemberSizeManufacturingConstraint ........................................................................................... 584
DataModelObjectCategory ..................................................................................................... 585
GapSize .................................................................................................................................. 585
GapSizeControlledType ........................................................................................................... 586
InternalObject ........................................................................................................................ 586
Location ................................................................................................................................. 586
Maximum ............................................................................................................................... 586
MaxSize .................................................................................................................................. 586
Minimum ............................................................................................................................... 586
MinSize .................................................................................................................................. 587
ScopingMethod ...................................................................................................................... 587
MeshConnection .......................................................................................................................... 587
ContactRegion ........................................................................................................................ 589
DataModelObjectCategory ..................................................................................................... 589
InternalObject ........................................................................................................................ 589
MasterElementSizeFactor ........................................................................................................ 589
ThicknessScaleFactor .............................................................................................................. 589

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

ToleranceValue ....................................................................................................................... 589

CreateNamedSelection() ......................................................................................................... 590
FlipMasterSlave() .................................................................................................................... 590
MeshConnectionBase ................................................................................................................... 590
Children ................................................................................................................................. 591
Comments .............................................................................................................................. 591
DataModelObjectCategory ..................................................................................................... 591
Figures ................................................................................................................................... 592
Images ................................................................................................................................... 592
InternalObject ........................................................................................................................ 592
MasterBodies .......................................................................................................................... 592
MasterLocation ....................................................................................................................... 592
ScopeMode ............................................................................................................................ 592
ScopingMethod ...................................................................................................................... 593
SlaveBodies ............................................................................................................................ 593
SlaveLocation ......................................................................................................................... 593
SnapToBoundary .................................................................................................................... 593
SnapTolerance ........................................................................................................................ 593
SnapType ............................................................................................................................... 593
Suppressed ............................................................................................................................ 594
ToleranceSlider ....................................................................................................................... 594
ToleranceType ........................................................................................................................ 594
AddComment() ....................................................................................................................... 594
AddFigure() ............................................................................................................................ 594
AddImage(string) ................................................................................................................... 594
Delete() .................................................................................................................................. 595
Generate() .............................................................................................................................. 595
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 595
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 595
RenameBasedOnDefinition() ................................................................................................... 596
MeshConnectionGroup ................................................................................................................. 596
DataModelObjectCategory ..................................................................................................... 598
InternalObject ........................................................................................................................ 598
AddManualMeshConnection() ................................................................................................ 599
DetectConnections() ............................................................................................................... 599
Generate() .............................................................................................................................. 599
SearchConnectionsForDuplicatePairs() .................................................................................... 599
MeshControlWorksheet ................................................................................................................ 599
RowCount .............................................................................................................................. 600
AddRow() ............................................................................................................................... 600
ClearGenerateMesh() .............................................................................................................. 600
DeleteAllRows() ...................................................................................................................... 600
DeleteRow(int) ....................................................................................................................... 601
GenerateAtRow(int) ................................................................................................................ 601
GenerateMesh() ...................................................................................................................... 601
GetActiveState(int) ................................................................................................................. 601
GetNamedSelection(int) ......................................................................................................... 602
GetNamedSelectionId(int) ...................................................................................................... 602
SetActiveState(int, bool) .......................................................................................................... 602
SetNamedSelection(int, NamedSelection) ............................................................................... 603
SetNamedSelectionId(int, uint) ................................................................................................ 603

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

MeshEdit ...................................................................................................................................... 603

AssociateToPullGeometry ....................................................................................................... 605
Children ................................................................................................................................. 605
Comments .............................................................................................................................. 605
DataModelObjectCategory ..................................................................................................... 605
Figures ................................................................................................................................... 605
GenerateAutomaticMeshConnectionsOnRefresh ..................................................................... 606
Images ................................................................................................................................... 606
InternalObject ........................................................................................................................ 606
TransparencyEnabled ............................................................................................................. 606
AddComment() ....................................................................................................................... 606
AddContactMatchGroup() ....................................................................................................... 606
AddDirectMorph() .................................................................................................................. 607
AddFigure() ............................................................................................................................ 607
AddImage(string) ................................................................................................................... 607
AddManualMeshConnection() ................................................................................................ 607
AddMeshConnectionGroup() .................................................................................................. 607
AddNodeMerge() .................................................................................................................... 608
AddNodeMergeGroup() .......................................................................................................... 608
AddNodeMove() ..................................................................................................................... 608
AddPullExtrude() .................................................................................................................... 608
AddPullRevolve() .................................................................................................................... 608
AddPullSurfaceCoating() ......................................................................................................... 608
ClearGeneratedData() ............................................................................................................. 609
CreateNamedSelectionForSharedNodes() ................................................................................ 609
Generate() .............................................................................................................................. 609
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 609
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 609
RenameBasedOnDefinition() ................................................................................................... 610
SearchConnectionsForDuplicatePairs() .................................................................................... 610
MeshExtrude ................................................................................................................................ 610
AxisOfRevolution .................................................................................................................... 612
Children ................................................................................................................................. 612
Comments .............................................................................................................................. 613
CoordinateSystem .................................................................................................................. 613
DataModelObjectCategory ..................................................................................................... 613
ExtrudeBy ............................................................................................................................... 613
FeatureAngle .......................................................................................................................... 613
Figures ................................................................................................................................... 613
Height .................................................................................................................................... 614
Images ................................................................................................................................... 614
InternalObject ........................................................................................................................ 614
Location ................................................................................................................................. 614
Material .................................................................................................................................. 614
MergeProfileNodes ................................................................................................................. 615
Method .................................................................................................................................. 615
NumberOfLayers .................................................................................................................... 615
RevolutionAngle ..................................................................................................................... 615
ScopingMethod ...................................................................................................................... 615
StiffnessOption ....................................................................................................................... 615
Suppressed ............................................................................................................................ 616

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

Thickness ............................................................................................................................... 616

UpTo ...................................................................................................................................... 616
UpToTarget ............................................................................................................................. 616
UseCoordinateSystem ............................................................................................................. 616
UseFeatureAngle .................................................................................................................... 616
AddComment() ....................................................................................................................... 617
AddFigure() ............................................................................................................................ 617
AddImage(string) ................................................................................................................... 617
ClearGeneratedData() ............................................................................................................. 617
Delete() .................................................................................................................................. 617
Generate() .............................................................................................................................. 618
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 618
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 618
MeshNumbering .......................................................................................................................... 619
Children ................................................................................................................................. 619
Comments .............................................................................................................................. 620
CompressNodeNumbers ......................................................................................................... 620
DataModelObjectCategory ..................................................................................................... 620
ElementOffset ........................................................................................................................ 620
Figures ................................................................................................................................... 620
Images ................................................................................................................................... 620
InternalObject ........................................................................................................................ 621
NodeOffset ............................................................................................................................. 621
Suppressed ............................................................................................................................ 621
AddComment() ....................................................................................................................... 621
AddFigure() ............................................................................................................................ 621
AddImage(string) ................................................................................................................... 621
AddNumberingControl() ......................................................................................................... 622
Delete() .................................................................................................................................. 622
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 622
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 622
RenumberMesh() .................................................................................................................... 623
Model ........................................................................................................................................... 623
AEDTImportManager .............................................................................................................. 629
Ambient ................................................................................................................................. 629
AMProcess .............................................................................................................................. 629
Analyses ................................................................................................................................. 630
CellId ...................................................................................................................................... 630
Children ................................................................................................................................. 630
Color ...................................................................................................................................... 630
Comments .............................................................................................................................. 630
CondensedGeometry .............................................................................................................. 630
Connections ........................................................................................................................... 631
ConstructionGeometry ........................................................................................................... 631
Control ................................................................................................................................... 631
CoordinateSystems ................................................................................................................. 631
CrossSections ......................................................................................................................... 631
DataModelObjectCategory ..................................................................................................... 631
Diffuse .................................................................................................................................... 632
Environments ***OBSOLETE*** Use 'Analyses' property instead. .............................................. 632
FeatureDetection .................................................................................................................... 632

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

Figures ................................................................................................................................... 632

Fracture .................................................................................................................................. 632
Geometry ............................................................................................................................... 632
GeometryImportGroup ........................................................................................................... 633
Images ................................................................................................................................... 633
InternalObject ........................................................................................................................ 633
Materials ................................................................................................................................ 633
Mesh ...................................................................................................................................... 633
MeshEdit ................................................................................................................................ 633
MeshNumbering .................................................................................................................... 634
NamedSelections .................................................................................................................... 634
ParameterVariableGroup ......................................................................................................... 634
PartTransformGroup ............................................................................................................... 634
RemotePoints ......................................................................................................................... 634
Specular ................................................................................................................................. 634
Symmetry ............................................................................................................................... 635
SystemCaption ....................................................................................................................... 635
VirtualTopology ...................................................................................................................... 635
AddAMProcess() ..................................................................................................................... 635
AddChart() ............................................................................................................................. 635
AddComment() ....................................................................................................................... 635
AddCondensedGeometry() ..................................................................................................... 636
AddConnections() ................................................................................................................... 636
AddConstructionGeometry() ................................................................................................... 636
AddCoSimulationPin() ............................................................................................................ 636
AddCoupledFieldHarmonic() ................................................................................................... 636
AddCoupledFieldModal() ........................................................................................................ 636
AddCoupledFieldStatic() ......................................................................................................... 637
AddCoupledFieldTransient() .................................................................................................... 637
AddDesignAssessmentAnalysis() ............................................................................................. 637
AddDesignLifeAnalysis() ......................................................................................................... 637
AddEigenvalueBucklingAnalysis() ............................................................................................ 637
AddElectricAnalysis() .............................................................................................................. 637
AddExplicitDynamicsAnalysis() ............................................................................................... 638
AddFatigueCombination() ....................................................................................................... 638
AddFeatureDetection() ........................................................................................................... 638
AddFigure() ............................................................................................................................ 638
AddForcedResponseAnalysis() ................................................................................................ 638
AddFracture() ......................................................................................................................... 638
AddGeometryImportGroup() .................................................................................................. 639
AddHarmonicAcousticAnalysis() .............................................................................................. 639
AddHarmonicResponseAnalysis() ............................................................................................ 639
AddImage(string) ................................................................................................................... 639
AddImagePlane() .................................................................................................................... 639
AddLSDynaAnalysis() .............................................................................................................. 640
AddMagnetostaticAnalysis() .................................................................................................... 640
AddMeshEdit() ........................................................................................................................ 640
AddMeshNumbering() ............................................................................................................ 640
AddModalAcousticAnalysis() ................................................................................................... 640
AddModalAnalysis() ................................................................................................................ 640
AddMotionAnalysis() .............................................................................................................. 641

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

AddNamedSelection() ............................................................................................................. 641

AddNamedSelectionFromSelectedConnections() .................................................................... 641
AddParameterVariableGroup() ................................................................................................ 641
AddPartTransform() ................................................................................................................ 641
AddPythonCodeEventBased() ................................................................................................. 642
AddPythonResult() .................................................................................................................. 642
AddRandomVibrationAnalysis() .............................................................................................. 642
AddRemotePoint() .................................................................................................................. 642
AddResponseSpectrumAnalysis() ............................................................................................ 642
AddRigidDynamicsAnalysis() ................................................................................................... 642
AddSolutionCombination() ..................................................................................................... 643
AddStaticAcousticAnalysis() .................................................................................................... 643
AddStaticStructuralAnalysis() .................................................................................................. 643
AddSteadyStateThermalAnalysis() ........................................................................................... 643
AddSubstructureGenerationAnalysis() ..................................................................................... 643
AddSymmetry() ...................................................................................................................... 643
AddThermalElectricAnalysis() .................................................................................................. 644
AddTopologyOptimizationAnalysis() ....................................................................................... 644
AddTransientStructuralAnalysis() ............................................................................................. 644
AddTransientThermalAnalysis() ............................................................................................... 644
AddTreeGroupingFolder(IDataModelObject) ........................................................................... 644
AddTreeGroupingFolder(IEnumerable) .................................................................................... 645
AddVirtualTopology() ............................................................................................................. 645
AutoFilter() ............................................................................................................................. 645
ClearGeneratedData() ............................................................................................................. 645
CreateCylindricalBolt(object, object, object, object) .................................................................. 645
CreateCylindricalNut(object, object, object) ............................................................................. 646
CreateHexBolt(object, object, object, object) ............................................................................ 646
CreateHexNut(object, object, object) ....................................................................................... 647
CreatePartInstance(IGeoPart) .................................................................................................. 647
DeleteParts(object) ................................................................................................................. 648
DisableFilter() ......................................................................................................................... 648
EvaluateScriptDefinedResults() ............................................................................................... 648
FreezeMeshOnSelectedParts(object) ....................................................................................... 648
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 649
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 649
GetFECommandsRepository(string, string) .............................................................................. 650
GetResults() ............................................................................................................................ 650
GetTransformationOnPart(IGeoPart) ........................................................................................ 650
LoadResultFile(string) ............................................................................................................. 650
RefreshMaterials() ................................................................................................................... 651
SetTransformationOnPart(IGeoPart, RigidBodyTransformationMatrix) ...................................... 651
Solve(bool, SolveConfiguration) .............................................................................................. 651
Solve(bool, string) ................................................................................................................... 652
UnfreezeMeshOnSelectedParts(object) ................................................................................... 652
UpdateGeometryFromSource() ............................................................................................... 652
MomentOfInertiaConstraint .......................................................................................................... 652
Axis ........................................................................................................................................ 653
CoordinateSystem .................................................................................................................. 653
DataModelObjectCategory ..................................................................................................... 654
DefineBy ................................................................................................................................ 654

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

InternalObject ........................................................................................................................ 654

Location ................................................................................................................................. 654
MaximumValue ...................................................................................................................... 654
MinimumValue ....................................................................................................................... 654
PercentageToRetain ................................................................................................................ 655
PercentageToRetainMax ......................................................................................................... 655
PercentageToRetainMin .......................................................................................................... 655
ScopingMethod ...................................................................................................................... 655
Selection ................................................................................................................................ 655
NamedSelection ........................................................................................................................... 655
Children ................................................................................................................................. 657
Comments .............................................................................................................................. 657
DataModelObjectCategory ..................................................................................................... 657
Figures ................................................................................................................................... 657
GenerationCriteria .................................................................................................................. 657
Images ................................................................................................................................... 658
IncludeProgramControlledInflation ......................................................................................... 658
InternalObject ........................................................................................................................ 658
Location ................................................................................................................................. 658
LSDynaUserId ......................................................................................................................... 658
PreserveDuringSolve .............................................................................................................. 658
RelativeTolerance .................................................................................................................... 659
ScopingMethod ...................................................................................................................... 659
SendAs ................................................................................................................................... 659
SendToSolver ......................................................................................................................... 659
Suppressed ............................................................................................................................ 659
ToleranceType ........................................................................................................................ 659
TotalSelection ......................................................................................................................... 660
Type ....................................................................................................................................... 660
UsedByMeshWorksheet .......................................................................................................... 660
Visible .................................................................................................................................... 660
ZeroTolerance ......................................................................................................................... 660
AddComment() ....................................................................................................................... 660
AddFigure() ............................................................................................................................ 661
AddImage(string) ................................................................................................................... 661
CreateNodalNamedSelection() ................................................................................................ 661
Delete() .................................................................................................................................. 661
ExportNamedSelectionToCDBFile(string) ................................................................................. 661
ExportToTextFile(string) .......................................................................................................... 662
Generate() .............................................................................................................................. 662
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 662
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 663
NamedSelectionCriteria ................................................................................................................ 663
Count ..................................................................................................................................... 664
Item(int) ................................................................................................................................. 664
Add(NamedSelectionCriterion) ............................................................................................... 664
Clear() .................................................................................................................................... 664
Contains(NamedSelectionCriterion) ........................................................................................ 665
IndexOf(NamedSelectionCriterion) ......................................................................................... 665
Insert(int, NamedSelectionCriterion) ........................................................................................ 665
Remove(NamedSelectionCriterion) ......................................................................................... 665

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

RemoveAt(int) ........................................................................................................................ 666

NamedSelectionCriterion .............................................................................................................. 666
NamedSelectionCriterion(bool, SelectionActionType, SelectionType, SelectionCriterionType,
SelectionOperatorType, object, Quantity, Quantity, CoordinateSystem) ..................................... 667
Action .................................................................................................................................... 668
Active ..................................................................................................................................... 668
CoordinateSystem .................................................................................................................. 668
Criterion ................................................................................................................................. 668
EntityType .............................................................................................................................. 668
LowerBound ........................................................................................................................... 668
Operator ................................................................................................................................. 669
UpperBound ........................................................................................................................... 669
Value ...................................................................................................................................... 669
NamedSelections .......................................................................................................................... 669
Children ................................................................................................................................. 670
Comments .............................................................................................................................. 670
DataModelObjectCategory ..................................................................................................... 670
Figures ................................................................................................................................... 670
GenerateOnRefresh ................................................................................................................ 671
GenerateOnRemesh ............................................................................................................... 671
Images ................................................................................................................................... 671
InternalObject ........................................................................................................................ 671
RandomColors ........................................................................................................................ 671
ShowAnnotations ................................................................................................................... 671
AddComment() ....................................................................................................................... 672
AddFigure() ............................................................................................................................ 672
AddImage(string) ................................................................................................................... 672
AddNamedSelection() ............................................................................................................. 672
Delete() .................................................................................................................................. 672
ExportNamedSelectionToCDBFile(string) ................................................................................. 673
GenerateAllNamedSelections() ............................................................................................... 673
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 673
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 673
GoToNamedSelectionsCommonToSelection() ......................................................................... 674
GoToNamedSelectionsContainingSelection() .......................................................................... 674
NastranExportOptions .................................................................................................................. 674
NastranExportOptions(string, string, int, int, double, double, string, int, double, bool) ................. 675
AnalysisType ........................................................................................................................... 676
GridCS .................................................................................................................................... 676
GroundCheck ......................................................................................................................... 676
JointStiffness .......................................................................................................................... 676
Modes .................................................................................................................................... 677
NastranFilename ..................................................................................................................... 677
Offset ..................................................................................................................................... 677
PyramidElements .................................................................................................................... 677
Time ....................................................................................................................................... 677
WTMass .................................................................................................................................. 677
NaturalFrequencyConstraint ......................................................................................................... 678
DataModelObjectCategory ..................................................................................................... 678
InternalObject ........................................................................................................................ 678
MaximumFrequency ............................................................................................................... 678

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

MinimumFrequency ............................................................................................................... 679

ModeNumber ......................................................................................................................... 679
NodeMerge .................................................................................................................................. 679
Children ................................................................................................................................. 680
Comments .............................................................................................................................. 680
DataModelObjectCategory ..................................................................................................... 680
Figures ................................................................................................................................... 680
Images ................................................................................................................................... 681
InternalObject ........................................................................................................................ 681
MasterBodies .......................................................................................................................... 681
MasterLocation ....................................................................................................................... 681
ScopingMethod ...................................................................................................................... 681
SlaveBodies ............................................................................................................................ 681
SlaveLocation ......................................................................................................................... 682
Suppressed ............................................................................................................................ 682
ToleranceType ........................................................................................................................ 682
ToleranceValue ....................................................................................................................... 682
AddComment() ....................................................................................................................... 682
AddFigure() ............................................................................................................................ 682
AddImage(string) ................................................................................................................... 683
Delete() .................................................................................................................................. 683
Generate() .............................................................................................................................. 683
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 683
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 684
RenameBasedOnDefinition() ................................................................................................... 684
NodeMergeGroup ........................................................................................................................ 684
DataModelObjectCategory ..................................................................................................... 686
InternalObject ........................................................................................................................ 687
AddNodeMerge() .................................................................................................................... 687
GenerateNodeMerge() ............................................................................................................ 687
NodeMove ................................................................................................................................... 687
Children ................................................................................................................................. 688
Comments .............................................................................................................................. 688
DataModelObjectCategory ..................................................................................................... 688
Figures ................................................................................................................................... 689
Images ................................................................................................................................... 689
Information ............................................................................................................................ 689
InternalObject ........................................................................................................................ 689
NumberOfMoves .................................................................................................................... 689
NumberOfNodes .................................................................................................................... 689
AddComment() ....................................................................................................................... 690
AddFigure() ............................................................................................................................ 690
AddImage(string) ................................................................................................................... 690
Delete() .................................................................................................................................. 690
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 690
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 691
MorphNodes() ........................................................................................................................ 691
MoveNode(int, Quantity, Quantity, Quantity) ............................................................................ 691
UndoAllNodeMoves() ............................................................................................................. 692
UndoLastNodeMove() ............................................................................................................. 692
NumberingControl ....................................................................................................................... 692

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

BeginElementNumber ............................................................................................................ 693

BeginNodeNumber ................................................................................................................. 693
Children ................................................................................................................................. 693
Comments .............................................................................................................................. 694
DataModelObjectCategory ..................................................................................................... 694
EndElementNumber ............................................................................................................... 694
EndNodeNumber ................................................................................................................... 694
Figures ................................................................................................................................... 694
Images ................................................................................................................................... 694
InternalObject ........................................................................................................................ 695
Location ................................................................................................................................. 695
NodeNumber ......................................................................................................................... 695
Suppressed ............................................................................................................................ 695
AddComment() ....................................................................................................................... 695
AddFigure() ............................................................................................................................ 695
AddImage(string) ................................................................................................................... 696
Delete() .................................................................................................................................. 696
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 696
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 696
Objective ...................................................................................................................................... 697
Children ................................................................................................................................. 698
Comments .............................................................................................................................. 698
DataModelObjectCategory ..................................................................................................... 698
Images ................................................................................................................................... 698
InternalObject ........................................................................................................................ 698
NormalizedSum ...................................................................................................................... 698
Suppressed ............................................................................................................................ 699
Worksheet .............................................................................................................................. 699
AddComment() ....................................................................................................................... 699
AddImage(string) ................................................................................................................... 699
Delete() .................................................................................................................................. 699
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 700
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 700
ObjectiveWorksheet ..................................................................................................................... 701
RowCount .............................................................................................................................. 702
AddRow() ............................................................................................................................... 702
DeleteRow(int) ....................................................................................................................... 702
GetEnabled(int) ...................................................................................................................... 702
GetEndMode(int) .................................................................................................................... 703
GetEndStep(int) ...................................................................................................................... 703
GetEnvironment(int) ............................................................................................................... 703
GetFormulation(int) ................................................................................................................ 703
GetMode(int) .......................................................................................................................... 704
GetMultipleSets(int) ................................................................................................................ 704
GetObjectiveType(int) ............................................................................................................. 704
GetStartMode(int) ................................................................................................................... 705
GetStartStep(int) .................................................................................................................... 705
GetStep(int) ............................................................................................................................ 705
GetWeight(int) ........................................................................................................................ 705
SetEnabled(int, bool) ............................................................................................................... 706
SetEndMode(int, int) ............................................................................................................... 706

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

SetEndStep(int, int) ................................................................................................................. 706

SetEnvironment(int, Analysis) .................................................................................................. 707
SetFormulation(int, TopoObjectiveFormulation) ...................................................................... 707
SetMode(int, int) ..................................................................................................................... 707
SetMultipleSets(int, bool) ........................................................................................................ 708
SetObjectiveType(int, ObjectiveType) ...................................................................................... 708
SetStartMode(int, int) .............................................................................................................. 709
SetStartStep(int, int) ................................................................................................................ 709
SetStep(int, int) ....................................................................................................................... 709
SetWeight(int, double) ............................................................................................................ 710
OptimizationRegion ..................................................................................................................... 710
BoundaryCondition ................................................................................................................ 711
DataModelObjectCategory ..................................................................................................... 711
DesignRegionLocation ............................................................................................................ 712
ExclusionThickness ................................................................................................................. 712
InitializationHoleSize .............................................................................................................. 712
InitializationModifierType ....................................................................................................... 712
InternalObject ........................................................................................................................ 712
LatticeMaxDensity .................................................................................................................. 712
LatticeMinDensity ................................................................................................................... 713
LatticeSize .............................................................................................................................. 713
LatticeType ............................................................................................................................. 713
MaxCumulatedDisplacementControl ....................................................................................... 713
MeshDeformationToleranceControl ........................................................................................ 713
MorphingIterationMoveLimit .................................................................................................. 713
MorphingTotalMeshDeformationTolerance ............................................................................. 714
MorphingTotalMoveLimit ....................................................................................................... 714
OptimizationType ................................................................................................................... 714
ShapeMoveLimitControl ......................................................................................................... 714
AddExclusionRegion() ............................................................................................................. 714
RenameBasedOnDefinition() ................................................................................................... 714
OptimizationRegionBaseClass ....................................................................................................... 715
Children ................................................................................................................................. 715
ExclusionRegionLocation ........................................................................................................ 715
ExclusionScopingMethod ....................................................................................................... 715
InternalObject ........................................................................................................................ 716
Delete() .................................................................................................................................. 716
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 716
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 716
ParameterVariable ........................................................................................................................ 717
Children ................................................................................................................................. 717
Comments .............................................................................................................................. 718
DataModelObjectCategory ..................................................................................................... 718
Figures ................................................................................................................................... 718
Images ................................................................................................................................... 718
InternalObject ........................................................................................................................ 718
AddComment() ....................................................................................................................... 718
AddFigure() ............................................................................................................................ 719
AddImage(string) ................................................................................................................... 719
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 719
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 720

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

ParameterVariableGroup ............................................................................................................... 720

Children ................................................................................................................................. 721
Comments .............................................................................................................................. 721
DataModelObjectCategory ..................................................................................................... 721
Figures ................................................................................................................................... 721
Images ................................................................................................................................... 721
InternalObject ........................................................................................................................ 722
AddComment() ....................................................................................................................... 722
AddFigure() ............................................................................................................................ 722
AddImage(string) ................................................................................................................... 722
AddParameterVariable() .......................................................................................................... 722
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 723
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 723
Part .............................................................................................................................................. 723
ApproximateSurfaceArea ........................................................................................................ 725
Assignment ***OBSOLETE*** Use 'Material' property instead. .................................................. 725
Average .................................................................................................................................. 725
CentroidX ............................................................................................................................... 725
CentroidY ............................................................................................................................... 726
CentroidZ ............................................................................................................................... 726
Children ................................................................................................................................. 726
Comments .............................................................................................................................. 726
ConfigurationId ...................................................................................................................... 726
CoordinateSystem .................................................................................................................. 726
DataModelObjectCategory ..................................................................................................... 727
Elements ................................................................................................................................ 727
Figures ................................................................................................................................... 727
Hidden ................................................................................................................................... 727
Images ................................................................................................................................... 727
InternalObject ........................................................................................................................ 727
LengthX ................................................................................................................................. 728
LengthY ................................................................................................................................. 728
LengthZ ................................................................................................................................. 728
Mass ....................................................................................................................................... 728
Material .................................................................................................................................. 728
MaterialName ***OBSOLETE*** Use 'Assignment' property instead. ......................................... 728
Maximum ............................................................................................................................... 729
MeshMetric ............................................................................................................................ 729
Minimum ............................................................................................................................... 729
MomentOfInertiaIp1 ............................................................................................................... 729
MomentOfInertiaIp2 ............................................................................................................... 729
MomentOfInertiaIp3 ............................................................................................................... 729
Nodes ..................................................................................................................................... 730
ResultMeshId .......................................................................................................................... 730
StandardDeviation .................................................................................................................. 730
Suppressed ............................................................................................................................ 730
Visible .................................................................................................................................... 730
Volume ................................................................................................................................... 730
AddComment() ....................................................................................................................... 731
AddFigure() ............................................................................................................................ 731
AddImage(string) ................................................................................................................... 731

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

ClearGeneratedData() ............................................................................................................. 731

GenerateMesh() ...................................................................................................................... 731
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 732
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 732
PreviewInflation() ................................................................................................................... 732
PreviewSurfaceMesh() ............................................................................................................ 733
Update() ................................................................................................................................. 733
PartTransform ............................................................................................................................... 733
Children ................................................................................................................................. 734
Comments .............................................................................................................................. 734
CoordinateSystem .................................................................................................................. 734
DataModelObjectCategory ..................................................................................................... 734
DefineBy ................................................................................................................................ 735
Figures ................................................................................................................................... 735
Images ................................................................................................................................... 735
InternalObject ........................................................................................................................ 735
Location ................................................................................................................................. 735
RotationX ............................................................................................................................... 735
RotationY ............................................................................................................................... 736
RotationZ ............................................................................................................................... 736
ScopingMethod ...................................................................................................................... 736
SourceCoordinateSystem ........................................................................................................ 736
Suppressed ............................................................................................................................ 736
TargetCoordinateSystem ......................................................................................................... 736
TranslationX ........................................................................................................................... 737
TranslationY ........................................................................................................................... 737
TranslationZ ........................................................................................................................... 737
AddComment() ....................................................................................................................... 737
AddFigure() ............................................................................................................................ 737
AddImage(string) ................................................................................................................... 737
Delete() .................................................................................................................................. 738
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 738
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 738
TransformGeometry() ............................................................................................................. 739
PartTransformGroup ..................................................................................................................... 739
Children ................................................................................................................................. 740
Comments .............................................................................................................................. 740
DataModelObjectCategory ..................................................................................................... 740
Figures ................................................................................................................................... 740
Images ................................................................................................................................... 740
InternalObject ........................................................................................................................ 741
RegenerateContacts ............................................................................................................... 741
Suppressed ............................................................................................................................ 741
TransformMesh ....................................................................................................................... 741
AddComment() ....................................................................................................................... 741
AddFigure() ............................................................................................................................ 741
AddImage(string) ................................................................................................................... 742
AddPartTransform() ................................................................................................................ 742
Delete() .................................................................................................................................. 742
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 742
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 743

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

TransformGeometry() ............................................................................................................. 743

Path ............................................................................................................................................. 743
Children ................................................................................................................................. 744
Comments .............................................................................................................................. 745
DataModelObjectCategory ..................................................................................................... 745
DiscretizationPoints ................................................................................................................ 745
EndCoordinateSystem ............................................................................................................ 745
EndXCoordinate ..................................................................................................................... 745
EndYCoordinate ...................................................................................................................... 745
EndZCoordinate ..................................................................................................................... 746
Figures ................................................................................................................................... 746
HasValidGeometrySelection .................................................................................................... 746
Images ................................................................................................................................... 746
InternalObject ........................................................................................................................ 746
Location ................................................................................................................................. 746
NumberOfSamplingPoints ...................................................................................................... 747
NumberOfSubpaths ................................................................................................................ 747
OffsetEdgeLocation ................................................................................................................ 747
PathCoordinateSystem ........................................................................................................... 747
PathType ................................................................................................................................ 747
ShowMesh ............................................................................................................................. 747
SnapToMeshNodes ................................................................................................................. 748
StartCoordinateSystem ........................................................................................................... 748
StartXCoordinate .................................................................................................................... 748
StartYCoordinate .................................................................................................................... 748
StartZCoordinate .................................................................................................................... 748
Suppressed ............................................................................................................................ 748
AddComment() ....................................................................................................................... 749
AddFigure() ............................................................................................................................ 749
AddImage(string) ................................................................................................................... 749
Delete() .................................................................................................................................. 749
FlipPathOrientatation() ........................................................................................................... 749
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 750
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 750
SnapPathToMeshNodes() ........................................................................................................ 750
PatternRepetitionConstraint ......................................................................................................... 751
Axis ........................................................................................................................................ 751
CoordinateSystem .................................................................................................................. 751
DataModelObjectCategory ..................................................................................................... 752
InternalObject ........................................................................................................................ 752
Location ................................................................................................................................. 752
Offset ..................................................................................................................................... 752
ScopingMethod ...................................................................................................................... 752
PeriodicRegion ............................................................................................................................. 752
DataModelObjectCategory ..................................................................................................... 753
InternalObject ........................................................................................................................ 754
Type ....................................................................................................................................... 754
PhysicsRegion .............................................................................................................................. 754
Acoustics ................................................................................................................................ 755
ArtificiallyMatchedLayers ........................................................................................................ 755
Children ................................................................................................................................. 756

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

DataModelObjectCategory ..................................................................................................... 756

Electric ................................................................................................................................... 756
ElementMorphing .................................................................................................................. 756
EvanescentWaveAttenuation .................................................................................................. 756
FluidBehavior ......................................................................................................................... 756
InternalObject ........................................................................................................................ 757
Location ................................................................................................................................. 757
PMLElementCoordinateSystem ............................................................................................... 757
PMLOptions ............................................................................................................................ 757
ReferencePressure .................................................................................................................. 757
ReferenceStaticPressure .......................................................................................................... 757
ReflectionCoefficient .............................................................................................................. 758
ReflectionCoefficientInNegativeXDirection .............................................................................. 758
ReflectionCoefficientInNegativeYDirection .............................................................................. 758
ReflectionCoefficientInNegativeZDirection .............................................................................. 758
ReflectionCoefficientInPositiveXDirection ............................................................................... 758
ReflectionCoefficientInPositiveYDirection ................................................................................ 758
ReflectionCoefficientInPositiveZDirection ................................................................................ 759
ReflectionCoefficientsType ...................................................................................................... 759
Structural ............................................................................................................................... 759
Suppressed ............................................................................................................................ 759
Thermal .................................................................................................................................. 759
ThermalStrain ......................................................................................................................... 759
ThermoelasticDamping .......................................................................................................... 760
Delete() .................................................................................................................................. 760
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 760
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 760
RenameBasedOnDefinition() ................................................................................................... 761
SelectInvalidBodiesOnPhysicsRegion() .................................................................................... 761
PipeIdealization ............................................................................................................................ 761
Children ................................................................................................................................. 762
DataModelObjectCategory ..................................................................................................... 762
Extend .................................................................................................................................... 762
Factor ..................................................................................................................................... 762
GeometrySelection ................................................................................................................. 762
InternalObject ........................................................................................................................ 763
Suppressed ............................................................................................................................ 763
Delete() .................................................................................................................................. 763
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 763
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 764
PointMass ..................................................................................................................................... 764
AppliedBy ............................................................................................................................... 765
BeamRadius ........................................................................................................................... 765
Behavior ................................................................................................................................. 766
CoordinateSystem .................................................................................................................. 766
DataModelObjectCategory ..................................................................................................... 766
InternalObject ........................................................................................................................ 766
Mass ....................................................................................................................................... 766
MassMomentOfInertiaX .......................................................................................................... 766
MassMomentOfInertiaY .......................................................................................................... 767
MassMomentOfInertiaZ .......................................................................................................... 767

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

Material .................................................................................................................................. 767

NodalCoordinateSystem ......................................................................................................... 767
PinballRegion ......................................................................................................................... 767
Suppressed ............................................................................................................................ 767
XCoordinate ........................................................................................................................... 768
YCoordinate ........................................................................................................................... 768
ZCoordinate ........................................................................................................................... 768
PromoteToRemotePoint() ........................................................................................................ 768
PostContactTool ........................................................................................................................... 768
DataModelObjectCategory ..................................................................................................... 769
InternalObject ........................................................................................................................ 769
AddFluidPressure() .................................................................................................................. 769
AddFrictionalStress() ............................................................................................................... 770
AddHeatFlux() ........................................................................................................................ 770
AddPressure() ......................................................................................................................... 770
AddSlidingDistance() .............................................................................................................. 770
PreContactTool ............................................................................................................................. 770
DataModelObjectCategory ..................................................................................................... 771
InternalObject ........................................................................................................................ 771
AddGap() ................................................................................................................................ 771
AddInitialInformation() ........................................................................................................... 772
AddPenetration() .................................................................................................................... 772
AddStatus() ............................................................................................................................ 772
PreMeshedCrack ........................................................................................................................... 772
BottomFaceNodes .................................................................................................................. 773
CoordinateSystem .................................................................................................................. 773
CrackFacesNodes .................................................................................................................... 773
CrackFront .............................................................................................................................. 773
CrackSourceType .................................................................................................................... 774
CrackSymmetry ...................................................................................................................... 774
DataModelObjectCategory ..................................................................................................... 774
InternalObject ........................................................................................................................ 774
ScopingMethod ...................................................................................................................... 774
SolutionContours ................................................................................................................... 774
Suppressed ............................................................................................................................ 775
TopFaceNodes ........................................................................................................................ 775
PreMeshedCyclicRegion ................................................................................................................ 775
BoundaryDOFOrientation ....................................................................................................... 776
DataModelObjectCategory ..................................................................................................... 776
InternalObject ........................................................................................................................ 776
NumberOfSectors ................................................................................................................... 776
RelativeDistanceTolerance ...................................................................................................... 777
PrimaryCriterion ........................................................................................................................... 777
BaseResult .............................................................................................................................. 778
BoundaryCondition ................................................................................................................ 778
DataModelObjectCategory ..................................................................................................... 778
DirectionX .............................................................................................................................. 778
DirectionY .............................................................................................................................. 779
DirectionZ .............................................................................................................................. 779
InternalObject ........................................................................................................................ 779
Location ................................................................................................................................. 779

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

LocationMethod ..................................................................................................................... 779

ModeNumber ......................................................................................................................... 779
ReferenceType ........................................................................................................................ 780
RemotePoint .......................................................................................................................... 780
RobustFrequenciesReduction ................................................................................................. 780
SpatialReduction .................................................................................................................... 780
SpatialReductionMethod ........................................................................................................ 780
Step ....................................................................................................................................... 780
Value ...................................................................................................................................... 781
VectorReduction ..................................................................................................................... 781
ClearGeneratedData() ............................................................................................................. 781
EvaluateAllResults() ................................................................................................................. 781
Project .......................................................................................................................................... 781
Author .................................................................................................................................... 782
Children ................................................................................................................................. 783
Comments .............................................................................................................................. 783
CreationDate .......................................................................................................................... 783
CreationTime .......................................................................................................................... 783
DataModelObjectCategory ..................................................................................................... 783
FirstSaved ............................................................................................................................... 783
Images ................................................................................................................................... 784
ImportedSource ..................................................................................................................... 784
ImportedVersion ..................................................................................................................... 784
InternalObject ........................................................................................................................ 784
LastSaved ............................................................................................................................... 784
Model ..................................................................................................................................... 784
Models ***OBSOLETE*** Use 'Model' property instead. ............................................................ 785
PreparedFor ............................................................................................................................ 785
ProductVersion ....................................................................................................................... 785
SaveProjectAfterSolution ........................................................................................................ 785
SaveProjectBeforeSolution ...................................................................................................... 785
Subject ................................................................................................................................... 785
UnitSystem ............................................................................................................................. 786
AddComment() ....................................................................................................................... 786
AddImage(string) ................................................................................................................... 786
ClearGeneratedData() ............................................................................................................. 786
CombineTextFiles(string, string) .............................................................................................. 786
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 787
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 787
SpecifyMetricTemperatureInCelsius() ...................................................................................... 788
SpecifyMetricTemperatureInKelvin() ........................................................................................ 788
PullOutDirectionManufacturingConstraint .................................................................................... 788
Axis ........................................................................................................................................ 789
CoordinateSystem .................................................................................................................. 789
DataModelObjectCategory ..................................................................................................... 789
Direction ................................................................................................................................ 789
InternalObject ........................................................................................................................ 789
Location ................................................................................................................................. 790
ScopingMethod ...................................................................................................................... 790
Subtype ................................................................................................................................. 790
PythonCode ................................................................................................................................. 790

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

Connected .............................................................................................................................. 791

DataModelObjectCategory ..................................................................................................... 791
InternalObject ........................................................................................................................ 791
PropertyProvider .................................................................................................................... 791
ScriptExecutionScope ............................................................................................................. 791
Text ........................................................................................................................................ 791
Connect() ............................................................................................................................... 792
Delete() .................................................................................................................................. 792
ReloadProperties() .................................................................................................................. 792
PythonCodeEventBased ................................................................................................................ 792
DataModelObjectCategory ..................................................................................................... 793
InternalObject ........................................................................................................................ 793
SolverTarget ........................................................................................................................... 793
Suppressed ............................................................................................................................ 793
TargetCallback ........................................................................................................................ 794
ReactionForceConstraint ............................................................................................................... 794
AxisSelection .......................................................................................................................... 794
BoundType ............................................................................................................................. 795
DataModelObjectCategory ..................................................................................................... 795
InternalObject ........................................................................................................................ 795
Location ................................................................................................................................. 795
ReactionForceCriteria .............................................................................................................. 795
ScopingMethod ...................................................................................................................... 795
XComponentMax .................................................................................................................... 796
YComponentMax .................................................................................................................... 796
ZComponentMax .................................................................................................................... 796
RectangularCrossSection .............................................................................................................. 796
Area ....................................................................................................................................... 797
DataModelObjectCategory ..................................................................................................... 797
Height .................................................................................................................................... 797
InternalObject ........................................................................................................................ 797
IYY ......................................................................................................................................... 797
IZZ ......................................................................................................................................... 798
Width ..................................................................................................................................... 798
RemotePoint ................................................................................................................................ 798
Behavior ................................................................................................................................. 799
Children ................................................................................................................................. 799
Comments .............................................................................................................................. 799
CoordinateSystem .................................................................................................................. 800
DataModelObjectCategory ..................................................................................................... 800
DOFSelection ......................................................................................................................... 800
GloballyAvailable .................................................................................................................... 800
InternalObject ........................................................................................................................ 800
Location ................................................................................................................................. 800
Material .................................................................................................................................. 801
OutlineSelection ..................................................................................................................... 801
PilotNodeAPDLName .............................................................................................................. 801
PilotNodeScopingType ........................................................................................................... 801
PinballRegion ......................................................................................................................... 801
Point ...................................................................................................................................... 801
Radius .................................................................................................................................... 802

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

RelaxationMethod .................................................................................................................. 802

RotationX ............................................................................................................................... 802
RotationY ............................................................................................................................... 802
RotationZ ............................................................................................................................... 802
ScopingMethod ...................................................................................................................... 802
Suppressed ............................................................................................................................ 803
XComponent .......................................................................................................................... 803
XCoordinate ........................................................................................................................... 803
YComponent .......................................................................................................................... 803
YCoordinate ........................................................................................................................... 803
ZComponent .......................................................................................................................... 803
ZCoordinate ........................................................................................................................... 804
AddCommandSnippet() .......................................................................................................... 804
AddComment() ....................................................................................................................... 804
Delete() .................................................................................................................................. 804
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 804
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 805
GetMeshRegion() .................................................................................................................... 805
PromoteToNamedSelection() .................................................................................................. 805
RemotePoints ............................................................................................................................... 806
Children ................................................................................................................................. 806
Comments .............................................................................................................................. 806
DataModelObjectCategory ..................................................................................................... 807
Figures ................................................................................................................................... 807
Images ................................................................................................................................... 807
InternalObject ........................................................................................................................ 807
AddComment() ....................................................................................................................... 807
AddFigure() ............................................................................................................................ 807
AddImage(string) ................................................................................................................... 808
AddRemotePoint() .................................................................................................................. 808
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 808
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 808
ResponseConstraint ...................................................................................................................... 809
Children ................................................................................................................................. 809
DataModelObjectCategory ..................................................................................................... 810
EnvironmentSelection ............................................................................................................ 810
InternalObject ........................................................................................................................ 810
Suppressed ............................................................................................................................ 810
Delete() .................................................................................................................................. 810
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 810
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 811
RenameBasedOnDefinition() ................................................................................................... 811
ResponsePSDTool ......................................................................................................................... 812
Children ................................................................................................................................. 812
ClusteringFrequencyPoints ..................................................................................................... 812
Comments .............................................................................................................................. 813
DataModelObjectCategory ..................................................................................................... 813
Figures ................................................................................................................................... 813
Images ................................................................................................................................... 813
IncludeAllExcitationFrequencies .............................................................................................. 813
IncludeUserDefinedFrequencies .............................................................................................. 813

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

InternalObject ........................................................................................................................ 814

AddComment() ....................................................................................................................... 814
AddFigure() ............................................................................................................................ 814
AddImage(string) ................................................................................................................... 814
AddResponsePSD() ................................................................................................................. 814
Delete() .................................................................................................................................. 815
EvaluateAllResults() ................................................................................................................. 815
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 815
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 815
ResultMesh ................................................................................................................................... 816
Children ................................................................................................................................. 817
Comments .............................................................................................................................. 817
ConfigurationId ...................................................................................................................... 817
DataModelObjectCategory ..................................................................................................... 817
Elements ................................................................................................................................ 817
FEBodies ................................................................................................................................ 818
Figures ................................................................................................................................... 818
Images ................................................................................................................................... 818
InternalObject ........................................................................................................................ 818
Nodes ..................................................................................................................................... 818
SourceFile ............................................................................................................................... 818
Suppressed ............................................................................................................................ 819
AddComment() ....................................................................................................................... 819
AddFigure() ............................................................................................................................ 819
AddImage(string) ................................................................................................................... 819
AddNamedSelection() ............................................................................................................. 819
ClearGeneratedData() ............................................................................................................. 820
Generate() .............................................................................................................................. 820
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 820
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 820
ImportComponentsFromResultFile() ....................................................................................... 821
RingCrack ..................................................................................................................................... 821
BottomFaceNodes .................................................................................................................. 822
CircumferentialDivisions ......................................................................................................... 822
Contact1Nodes ....................................................................................................................... 823
ContactPairsNodes ................................................................................................................. 823
CoordinateSystem .................................................................................................................. 823
CrackFacesNodes .................................................................................................................... 823
CrackFrontNodes .................................................................................................................... 823
CrackMeshMethod ................................................................................................................. 823
CrackShape ............................................................................................................................ 824
CrackSourceType .................................................................................................................... 824
DataModelObjectCategory ..................................................................................................... 824
FractureAffectedZone ............................................................................................................. 824
FractureAffectedZoneHeight ................................................................................................... 824
FrontElementSize .................................................................................................................... 824
GrowthRate ............................................................................................................................ 825
InnerCrackFrontDivisions ........................................................................................................ 825
InnerMajorRadius ................................................................................................................... 825
InnerMinorRadius ................................................................................................................... 825
InternalObject ........................................................................................................................ 825

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

LargestContourRadius ............................................................................................................ 825

Location ................................................................................................................................. 826
MajorRadius ........................................................................................................................... 826
MeshContours ........................................................................................................................ 826
MinorRadius ........................................................................................................................... 826
OuterCrackFrontDivisions ....................................................................................................... 826
SolutionContours ................................................................................................................... 826
Suppressed ............................................................................................................................ 827
Target1Nodes ......................................................................................................................... 827
TopFaceNodes ........................................................................................................................ 827
XScaleFactor ........................................................................................................................... 827
YScaleFactor ........................................................................................................................... 827
ZScaleFactor ........................................................................................................................... 827
SelectionWorksheet ...................................................................................................................... 828
RowCount .............................................................................................................................. 829
AddRow() ............................................................................................................................... 830
DeleteRow(int) ....................................................................................................................... 830
Generate() .............................................................................................................................. 830
GetAction(int) ......................................................................................................................... 830
GetBodyTypeValue(int) ........................................................................................................... 830
GetCoordinateSystemSelection(int) ........................................................................................ 831
GetCriterion(int) ..................................................................................................................... 831
GetCriterionActive(int) ............................................................................................................ 831
GetEdgeTypeValue(int) ........................................................................................................... 832
GetFaceTypeValue(int) ............................................................................................................ 832
GetGeometryType(int) ............................................................................................................ 832
GetLowerBound(int) ............................................................................................................... 833
GetMeshElementTypeValue(int) .............................................................................................. 833
GetOperator(int) ..................................................................................................................... 833
GetStringValue(int) ................................................................................................................. 833
GetTag(uint) ........................................................................................................................... 834
GetUpperBound(int) ............................................................................................................... 834
GetValue(int) .......................................................................................................................... 834
SetAction(int, NamedSelectionWorksheetAction) .................................................................... 835
SetBodyTypeValue(int, NamedSelectionWorksheetBodyTypeValues) ........................................ 835
SetCoordinateSystemSelection(int, uint) .................................................................................. 835
SetCriterion(int, NamedSelectionWorksheetCriterion) .............................................................. 836
SetCriterionActive(int, bool) .................................................................................................... 836
SetEdgeTypeValue(int, NamedSelectionWorksheetEdgeTypeValues) ........................................ 836
SetEntityType(int, NamedSelectionWorksheetEntityType) ........................................................ 837
SetFaceTypeValue(int, NamedSelectionWorksheetFaceTypeValues) .......................................... 837
SetLowerBound(int, double) .................................................................................................... 837
SetMeshElementTypeValue(int, MeshElementShape) ............................................................... 838
SetOperator(int, NamedSelectionWorksheetOperator) ............................................................. 838
SetStringValue(int, string) ........................................................................................................ 839
SetTag(uint, string) .................................................................................................................. 839
SetUpperBound(int, double) ................................................................................................... 839
SetValue(int, double) ............................................................................................................... 840
SemiEllipticalCrack ....................................................................................................................... 840
AlignWithFaceNormal ............................................................................................................. 841
BottomFaceNodes .................................................................................................................. 841

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

CircumferentialDivisions ......................................................................................................... 842

Contact1Nodes ....................................................................................................................... 842
ContactPairsNodes ................................................................................................................. 842
CoordinateSystem .................................................................................................................. 842
CrackFacesNodes .................................................................................................................... 842
CrackFrontDivisions ................................................................................................................ 842
CrackFrontNodes .................................................................................................................... 843
CrackMeshMethod ................................................................................................................. 843
CrackShape ............................................................................................................................ 843
CrackSourceType .................................................................................................................... 843
DataModelObjectCategory ..................................................................................................... 843
FractureAffectedZone ............................................................................................................. 843
FractureAffectedZoneHeight ................................................................................................... 844
FrontElementSize .................................................................................................................... 844
GrowthRate ............................................................................................................................ 844
InternalObject ........................................................................................................................ 844
LargestContourRadius ............................................................................................................ 844
Location ................................................................................................................................. 844
MajorRadius ........................................................................................................................... 845
MeshContours ........................................................................................................................ 845
MinorRadius ........................................................................................................................... 845
ProjectToNearestSurface ......................................................................................................... 845
SolutionContours ................................................................................................................... 845
Suppressed ............................................................................................................................ 845
Target1Nodes ......................................................................................................................... 846
TopFaceNodes ........................................................................................................................ 846
XScaleFactor ........................................................................................................................... 846
YScaleFactor ........................................................................................................................... 846
ZScaleFactor ........................................................................................................................... 846
SMARTCrackGrowth ...................................................................................................................... 846
Analysis .................................................................................................................................. 848
AutomaticTimeStepping ......................................................................................................... 848
CrackGrowthLaw .................................................................................................................... 848
CrackGrowthMethodology ...................................................................................................... 848
CrackGrowthOption ................................................................................................................ 848
CriticalRate ............................................................................................................................. 849
DataModelObjectCategory ..................................................................................................... 849
FailureCriteriaOption .............................................................................................................. 849
InitialCrack ............................................................................................................................. 849
InitialTimeStep ....................................................................................................................... 849
InternalObject ........................................................................................................................ 849
Material .................................................................................................................................. 850
MaximumTimeStep ................................................................................................................ 850
MaxIncrementOfCrackExtension ............................................................................................. 850
MaxIncrementValue ................................................................................................................ 850
Method .................................................................................................................................. 850
MinimumTimeStep ................................................................................................................. 850
MinIncrementOfCrackExtension .............................................................................................. 851
MinIncrementValue ................................................................................................................ 851
NumberOfCycles ..................................................................................................................... 851
StopAtMaxCrackExtension ...................................................................................................... 851

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

StopAtMaxCrackExtensionValue .............................................................................................. 851

StressRatio .............................................................................................................................. 851
Suppressed ............................................................................................................................ 852
Solid ............................................................................................................................................. 852
Children ................................................................................................................................. 853
Comments .............................................................................................................................. 853
CoordinateSystem .................................................................................................................. 853
DataModelObjectCategory ..................................................................................................... 853
InternalObject ........................................................................................................................ 853
PartName ............................................................................................................................... 853
X1 .......................................................................................................................................... 854
X2 .......................................................................................................................................... 854
Y1 .......................................................................................................................................... 854
Y2 .......................................................................................................................................... 854
Z1 .......................................................................................................................................... 854
Z2 .......................................................................................................................................... 854
AddComment() ....................................................................................................................... 855
AddGeometry() ....................................................................................................................... 855
Delete() .................................................................................................................................. 855
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 855
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 855
RemoveGeometry() ................................................................................................................ 856
UpdateGeometry() .................................................................................................................. 856
Solution ....................................................................................................................................... 856
AllThreadsCPUTime ................................................................................................................ 867
CalculateBeamSectionResults ................................................................................................. 867
CellId ...................................................................................................................................... 867
Children ................................................................................................................................. 868
Comments .............................................................................................................................. 868
CyclicSectorDisplayRangeBegin .............................................................................................. 868
DataModelObjectCategory ..................................................................................................... 868
DateOfRun ............................................................................................................................. 868
EigenSolverType ..................................................................................................................... 868
ElapsedRunTime ..................................................................................................................... 869
ElapsedTime ........................................................................................................................... 869
ElementLoadBalRatio .............................................................................................................. 869
Elements ................................................................................................................................ 869
ElementSelection ................................................................................................................... 869
EquationSolverType ................................................................................................................ 869
ExportTopologyFile ................................................................................................................. 870
Figures ................................................................................................................................... 870
GpuAcceleration ..................................................................................................................... 870
GPUType ................................................................................................................................ 870
Images ................................................................................................................................... 870
InternalObject ........................................................................................................................ 870
IOBound ................................................................................................................................. 871
IORead ................................................................................................................................... 871
IOWrite ................................................................................................................................... 871
IsDataExtractionComplete ...................................................................................................... 871
IsDistributedSolution .............................................................................................................. 871
IsEigenSolver .......................................................................................................................... 871

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

IsGPUAccelerationRequested .................................................................................................. 872

IsHybridParallelSolution .......................................................................................................... 872
IsUnsymmetricMatrixSolve ...................................................................................................... 872
License ................................................................................................................................... 872
LicenseCoresAvailable ............................................................................................................. 872
MainThreadCPUTime .............................................................................................................. 872
MaximumRefinementLoops .................................................................................................... 873
MemoryAvailable .................................................................................................................... 873
MemoryUsed .......................................................................................................................... 873
MeshSource ............................................................................................................................ 873
MPIType ................................................................................................................................. 873
MSUPHarmonicAnalysis .......................................................................................................... 873
Nodes ..................................................................................................................................... 874
NumberOfDOF ....................................................................................................................... 874
NumberOfProcessesRequested ............................................................................................... 874
NumberofSectors ................................................................................................................... 874
NumCoresAvailable ................................................................................................................ 874
NumGPURequested ................................................................................................................ 874
NumMachinesRequested ........................................................................................................ 875
NumProcRequested ................................................................................................................ 875
NumVirtualCoresAvailable ...................................................................................................... 875
OperatingSystem .................................................................................................................... 875
ProcessorModel ...................................................................................................................... 875
RefinementDepth ................................................................................................................... 875
ResultFileDirectory ................................................................................................................. 876
ResultFileName ....................................................................................................................... 876
ResultFilePath ......................................................................................................................... 876
ResultFileSize .......................................................................................................................... 876
ResultFileTimestamp ............................................................................................................... 876
ResultFileUnitSystem .............................................................................................................. 876
ResultTrackingVectorLength ................................................................................................... 877
SolutionInformation ............................................................................................................... 877
SolutionTrackingVectorLength ................................................................................................ 877
SolutionUnitSystem ................................................................................................................ 877
SolverData .............................................................................................................................. 877
SolverType .............................................................................................................................. 877
SparseMode ........................................................................................................................... 878
Status ..................................................................................................................................... 878
ThreadsPerProcessRequested .................................................................................................. 878
TimeOfRun ............................................................................................................................. 878
TimeToCombineDistributedFiles ............................................................................................. 878
TopologyResult ....................................................................................................................... 878
TotalMemoryUsed .................................................................................................................. 879
WorkingDir ............................................................................................................................. 879
AddAccelerationFrequencyResponse() .................................................................................... 879
AddAccelerationPhaseResponse() ........................................................................................... 879
AddAccelerationProbe() .......................................................................................................... 879
AddAccumulatedEquivalentPlasticStrain() ............................................................................... 879
AddAcousticAbsorptionCoefficient() ....................................................................................... 880
AddAcousticAWeightedSoundPressureLevel() ......................................................................... 880
AddAcousticAWeightedSPLFrequencyResponse() .................................................................... 880

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

AddAcousticDiffuseSoundTransmissionLoss() .......................................................................... 880

AddAcousticDirectionalVelocityResult() ................................................................................... 880
AddAcousticFarFieldAWeightedSPL() ....................................................................................... 880
AddAcousticFarFieldAWeightedSPLMic() ................................................................................. 881
AddAcousticFarFieldDirectivity() ............................................................................................. 881
AddAcousticFarFieldMaximumPressure() ................................................................................. 881
AddAcousticFarFieldMaximumPressureMic() ........................................................................... 881
AddAcousticFarFieldMaximumScatteredPressure() .................................................................. 881
AddAcousticFarFieldPhase() .................................................................................................... 881
AddAcousticFarFieldPhaseMic() .............................................................................................. 882
AddAcousticFarFieldSoundPowerLevel() .................................................................................. 882
AddAcousticFarFieldSoundPowerLevelWaterfallDiagram() ....................................................... 882
AddAcousticFarFieldSPL() ....................................................................................................... 882
AddAcousticFarFieldSPLMic() .................................................................................................. 882
AddAcousticFarFieldSPLMicWaterfallDiagram() ....................................................................... 882
AddAcousticFarFieldTargetStrength() ...................................................................................... 883
AddAcousticFrequencyBandAWeightedSPL() ........................................................................... 883
AddAcousticFrequencyBandSPL() ........................................................................................... 883
AddAcousticKineticEnergy() .................................................................................................... 883
AddAcousticKineticEnergyFrequencyResponse() ..................................................................... 883
AddAcousticPotentialEnergy() ................................................................................................. 883
AddAcousticPotentialEnergyFrequencyResponse() .................................................................. 884
AddAcousticPressureFrequencyResponse() ............................................................................. 884
AddAcousticPressureResult() ................................................................................................... 884
AddAcousticReturnLoss() ........................................................................................................ 884
AddAcousticSoundPressureLevel() .......................................................................................... 884
AddAcousticSPLFrequencyResponse() ..................................................................................... 884
AddAcousticTotalVelocityResult() ............................................................................................ 885
AddAcousticTransmissionLoss() .............................................................................................. 885
AddAcousticVelocityFrequencyResponse() .............................................................................. 885
AddAngularAccelerationProbe() .............................................................................................. 885
AddAngularVelocityProbe() ..................................................................................................... 885
AddBeamProbe() .................................................................................................................... 885
AddBeamTool() ....................................................................................................................... 886
AddBearingProbe() ................................................................................................................. 886
AddBendingStressEquivalent() ................................................................................................ 886
AddBendingStressIntensity() ................................................................................................... 886
AddBoltPretensionProbe() ...................................................................................................... 886
AddBoltTool() ......................................................................................................................... 886
AddCampbellDiagram() .......................................................................................................... 887
AddChargeReactionFrequencyResponse() ............................................................................... 887
AddChargeReactionProbe() ..................................................................................................... 887
AddCommandSnippet() .......................................................................................................... 887
AddComment() ....................................................................................................................... 887
AddCompositeCriterion() ........................................................................................................ 887
AddCompositeFailureTool() ..................................................................................................... 888
AddCompositeSamplingPointTool() ........................................................................................ 888
AddContactTool() ................................................................................................................... 888
AddCurrentDensity() ............................................................................................................... 888
AddCurrentDensityProbe() ...................................................................................................... 888
AddDamageStatus() ................................................................................................................ 888

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

AddDeformationFrequencyResponse() .................................................................................... 889

AddDeformationPhaseResponse() ........................................................................................... 889
AddDeformationProbe() ......................................................................................................... 889
AddDirectionalAcceleration() .................................................................................................. 889
AddDirectionalAccelerationPSD() ............................................................................................ 889
AddDirectionalAccelerationRS() .............................................................................................. 889
AddDirectionalAxialForce() ..................................................................................................... 890
AddDirectionalBendingMoment() ........................................................................................... 890
AddDirectionalCurrentDensity() .............................................................................................. 890
AddDirectionalDeformation() .................................................................................................. 890
AddDirectionalElectricFieldIntensity() ..................................................................................... 890
AddDirectionalElectricFluxDensity() ........................................................................................ 890
AddDirectionalHeatFlux() ........................................................................................................ 891
AddDirectionalMagneticFieldIntensity() .................................................................................. 891
AddDirectionalMagneticFluxDensity() ..................................................................................... 891
AddDirectionalShearForce() .................................................................................................... 891
AddDirectionalTorsionalMoment() .......................................................................................... 891
AddDirectionalVelocity() ......................................................................................................... 891
AddDirectionalVelocityPSD() ................................................................................................... 892
AddDirectionalVelocityRS() ..................................................................................................... 892
AddElasticStrainFrequencyResponse() ..................................................................................... 892
AddElasticStrainIntensity() ...................................................................................................... 892
AddElasticStrainPhaseResponse() ............................................................................................ 892
AddElectricFieldProbe() .......................................................................................................... 892
AddElectricPotential() ............................................................................................................. 893
AddElectricVoltage() ............................................................................................................... 893
AddElectromechanicalCouplingCoefficient() ........................................................................... 893
AddElementalEulerXYAngle() .................................................................................................. 893
AddElementalEulerXZAngle() .................................................................................................. 893
AddElementalEulerYZAngle() .................................................................................................. 893
AddElementalStrainEnergy() ................................................................................................... 894
AddElementalTriads() .............................................................................................................. 894
AddEmagReactionProbe() ....................................................................................................... 894
AddEnergyDissipatedPerUnitVolume() .................................................................................... 894
AddEnergyProbe() .................................................................................................................. 894
AddEquivalentCreepStrain() .................................................................................................... 894
AddEquivalentCreepStrainRST() .............................................................................................. 895
AddEquivalentElasticStrain() ................................................................................................... 895
AddEquivalentElasticStrainRST() .............................................................................................. 895
AddEquivalentPlasticStrain() ................................................................................................... 895
AddEquivalentPlasticStrainRST() .............................................................................................. 895
AddEquivalentRadiatedPower() ............................................................................................... 895
AddEquivalentRadiatedPowerLevel() ....................................................................................... 896
AddEquivalentRadiatedPowerLevelWaterfallDiagram() ............................................................ 896
AddEquivalentRadiatedPowerWaterfallDiagram() .................................................................... 896
AddEquivalentStress() ............................................................................................................. 896
AddEquivalentStressPSD() ....................................................................................................... 896
AddEquivalentStressRS() ......................................................................................................... 897
AddEquivalentTotalStrain() ..................................................................................................... 897
AddExpansionSettings() .......................................................................................................... 897
AddFatigueTool() .................................................................................................................... 897

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

AddFiberCompressiveDamageVariable() ................................................................................. 897

AddFiberCompressiveFailureCriterion() ................................................................................... 897
AddFiberTensileDamageVariable() ........................................................................................... 898
AddFiberTensileFailureCriterion() ............................................................................................ 898
AddFieldIntensityProbe() ........................................................................................................ 898
AddFigure() ............................................................................................................................ 898
AddFlexibleRotationProbe() .................................................................................................... 898
AddFluidFlowRate() ................................................................................................................ 898
AddFluidHeatConductionRate() .............................................................................................. 899
AddFluidHeatTransportRate() .................................................................................................. 899
AddFluxDensityProbe() ........................................................................................................... 899
AddFluxLinkage() .................................................................................................................... 899
AddForceReaction() ................................................................................................................ 899
AddForceReactionFrequencyResponse() ................................................................................. 899
AddForceReactionsForContactRegions(IEnumerable<int>) ...................................................... 900
AddForceSummationProbe() ................................................................................................... 900
AddFractureTool() ................................................................................................................... 900
AddGeneralizedPlaneStrainProbe() ......................................................................................... 900
AddGroupedScopedACPResults(ResultType, IEnumerable<IDataModelObject>) ...................... 900
AddGroupedScopedCustomResult(IEnumerable<IDataModelObject>) .................................... 901
AddHeatFluxProbe() ............................................................................................................... 901
AddImage(string) ................................................................................................................... 901
AddImpedanceFrequencyResponse() ...................................................................................... 901
AddImpedanceProbe() ............................................................................................................ 902
AddInductance() ..................................................................................................................... 902
AddJointProbe() ..................................................................................................................... 902
AddJouleHeat() ....................................................................................................................... 902
AddJouleHeatProbe() .............................................................................................................. 902
AddLatticeDensity() ................................................................................................................ 902
AddLatticeElementalDensity() ................................................................................................. 903
AddLinearizedEquivalentStress() ............................................................................................. 903
AddLinearizedMaximumPrincipalStress() ................................................................................. 903
AddLinearizedMaximumShearStress() ..................................................................................... 903
AddLinearizedMiddlePrincipalStress() ..................................................................................... 903
AddLinearizedMinimumPrincipalStress() ................................................................................. 903
AddLinearizedNormalStress() .................................................................................................. 904
AddLinearizedShearStress() ..................................................................................................... 904
AddLinearizedStressIntensity() ................................................................................................ 904
AddLinePressureResult() ......................................................................................................... 904
AddMagneticCoenergy() ......................................................................................................... 904
AddMagneticDirectionalForces() ............................................................................................. 904
AddMagneticError() ................................................................................................................ 905
AddMagneticFluxProbe() ........................................................................................................ 905
AddMagneticPotential() .......................................................................................................... 905
AddMagneticTotalForces() ...................................................................................................... 905
AddMatrixCompressiveDamageVariable() ............................................................................... 905
AddMatrixCompressiveFailureCriterion() ................................................................................. 905
AddMatrixTensileDamageVariable() ........................................................................................ 906
AddMatrixTensileFailureCriterion() .......................................................................................... 906
AddMaximumFailureCriteria() ................................................................................................. 906
AddMaximumPrincipalElasticStrain() ....................................................................................... 906

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

AddMaximumPrincipalStress() ................................................................................................ 906

AddMaximumPrincipalThermalStrain() .................................................................................... 906
AddMaximumShearElasticStrain() ........................................................................................... 907
AddMaximumShearStress() ..................................................................................................... 907
AddMembraneStressEquivalent() ............................................................................................ 907
AddMembraneStressIntensity() ............................................................................................... 907
AddMiddlePrincipalElasticStrain() ............................................................................................ 907
AddMiddlePrincipalStress() ..................................................................................................... 907
AddMiddlePrincipalThermalStrain() ......................................................................................... 908
AddMinimumPrincipalElasticStrain() ....................................................................................... 908
AddMinimumPrincipalStress() ................................................................................................. 908
AddMomentReaction() ........................................................................................................... 908
AddMomentReactionsForContactRegions(IEnumerable<int>) ................................................. 908
AddMullinsDamageVariable() .................................................................................................. 909
AddMullinsMaximumPreviousStrainEnergy() ........................................................................... 909
AddNewtonRaphsonResidualCharge() .................................................................................... 909
AddNewtonRaphsonResidualForce() ....................................................................................... 909
AddNewtonRaphsonResidualHeat() ........................................................................................ 909
AddNewtonRaphsonResidualMoment() .................................................................................. 910
AddNodalEulerXYAngle() ........................................................................................................ 910
AddNodalEulerXZAngle() ........................................................................................................ 910
AddNodalEulerYZAngle() ........................................................................................................ 910
AddNodalTriads() .................................................................................................................... 910
AddNormalElasticStrain() ........................................................................................................ 910
AddNormalGasketPressure() ................................................................................................... 911
AddNormalGasketTotalClosure() ............................................................................................. 911
AddNormalStress() .................................................................................................................. 911
AddPosition() .......................................................................................................................... 911
AddPrimaryCriterion() ............................................................................................................. 911
AddPythonCodeEventBased() ................................................................................................. 911
AddPythonResult() .................................................................................................................. 912
AddQualityFactor() ................................................................................................................. 912
AddRadiationProbe() .............................................................................................................. 912
AddReactionProbe() ............................................................................................................... 912
AddReactionsForContactRegions(IEnumerable<int>) .............................................................. 912
AddResponsePSD() ................................................................................................................. 913
AddResponsePSDTool() ........................................................................................................... 913
AddResultMesh() .................................................................................................................... 913
AddRotationProbe() ................................................................................................................ 913
AddShapeFinder() ................................................................................................................... 913
AddShapeFinderElemental() ................................................................................................... 913
AddShearDamageVariable() .................................................................................................... 914
AddShearElasticStrain() ........................................................................................................... 914
AddShearGasketPressure() ...................................................................................................... 914
AddShearGasketTotalClosure() ................................................................................................ 914
AddShearMomentDiagramMSUM() ......................................................................................... 914
AddShearMomentDiagramMY() .............................................................................................. 914
AddShearMomentDiagramMZ() .............................................................................................. 915
AddShearMomentDiagramUSUM() .......................................................................................... 915
AddShearMomentDiagramUY() ............................................................................................... 915
AddShearMomentDiagramUZ() ............................................................................................... 915

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

AddShearMomentDiagramVSUM() .......................................................................................... 915

AddShearMomentDiagramVY() ............................................................................................... 915
AddShearMomentDiagramVZ() ............................................................................................... 916
AddShearStress() .................................................................................................................... 916
AddShellBendingStress() ......................................................................................................... 916
AddShellBottomPeakStress() ................................................................................................... 916
AddShellMembraneStress() ..................................................................................................... 916
AddShellTopPeakStress() ......................................................................................................... 916
AddSpringProbe() ................................................................................................................... 917
AddStabilizationEnergy() ........................................................................................................ 917
AddStrainProbe() .................................................................................................................... 917
AddStressFrequencyResponse() .............................................................................................. 917
AddStressIntensity() ................................................................................................................ 917
AddStressPhaseResponse() ..................................................................................................... 917
AddStressProbe() .................................................................................................................... 918
AddStressTool() ...................................................................................................................... 918
AddStructuralError() ................................................................................................................ 918
AddStructuralStrainEnergy() ................................................................................................... 918
AddTemperature() .................................................................................................................. 918
AddTemperatureProbe() ......................................................................................................... 918
AddThermalError() .................................................................................................................. 919
AddThermalStrain() ................................................................................................................ 919
AddThermalStrainEnergy() ...................................................................................................... 919
AddTopologyDensity() ............................................................................................................ 919
AddTopologyElementalDensity() ............................................................................................. 919
AddTorqueProbe() .................................................................................................................. 919
AddTotalAcceleration() ........................................................................................................... 920
AddTotalAxialForce() ............................................................................................................... 920
AddTotalBendingMoment() .................................................................................................... 920
AddTotalCurrentDensity() ....................................................................................................... 920
AddTotalDeformation() ........................................................................................................... 920
AddTotalElectricFieldIntensity() ............................................................................................... 920
AddTotalElectricFluxDensity() ................................................................................................. 921
AddTotalHeatFlux() ................................................................................................................. 921
AddTotalMagneticFieldIntensity() ............................................................................................ 921
AddTotalMagneticFluxDensity() .............................................................................................. 921
AddTotalShearForce() ............................................................................................................. 921
AddTotalTorsionalMoment() .................................................................................................... 921
AddTotalVelocity() .................................................................................................................. 922
AddUserDefinedResult() .......................................................................................................... 922
AddVariableGraph() ................................................................................................................ 922
AddVectorAxialForce() ............................................................................................................ 922
AddVectorBendingMoment() .................................................................................................. 922
AddVectorDeformation() ......................................................................................................... 922
AddVectorHeatFlux() ............................................................................................................... 923
AddVectorPrincipalElasticStrain() ............................................................................................ 923
AddVectorPrincipalStress() ...................................................................................................... 923
AddVectorShearForce() ........................................................................................................... 923
AddVectorTorsionalMoment() ................................................................................................. 923
AddVelocityFrequencyResponse() ........................................................................................... 923
AddVelocityPhaseResponse() .................................................................................................. 924

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

AddVelocityProbe() ................................................................................................................. 924

AddVoltageFrequencyResponse() ........................................................................................... 924
AddVoltageProbe() ................................................................................................................. 924
AddVolume() .......................................................................................................................... 924
AddVolumeProbe() ................................................................................................................. 924
ClearGeneratedData() ............................................................................................................. 925
CreateResultsAtAllSets(uint) .................................................................................................... 925
DeleteRow(uint) ..................................................................................................................... 925
EvaluateAllContactTrackers() ................................................................................................... 925
EvaluateAllResults() ................................................................................................................. 925
EvaluateContactTracker() ........................................................................................................ 926
ExecutePostCommands() ........................................................................................................ 926
ExecutePostCommands(IEnumerable<IDataModelObject>) .................................................... 926
ExportSubstructureInCPAFormat(string, bool) .......................................................................... 926
ExtractSolutionStatistics() ....................................................................................................... 927
FetchRemoteResults() ............................................................................................................. 927
FormatValue(double, int) ......................................................................................................... 927
GenerateAdaptedMesh() ......................................................................................................... 927
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 927
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 928
GetResults() ............................................................................................................................ 928
IsResultFileChanged() ............................................................................................................. 928
IsResultFileSameAsLoaded(string) ........................................................................................... 929
OpenSolverFilesDirectory() ..................................................................................................... 929
ReadAnsysResultFile() ............................................................................................................. 929
ReadGivenAnsysResultFile(string, UnitSystemIDType) .............................................................. 929
RelinkResultFile(string) ........................................................................................................... 930
ReloadResultFile() ................................................................................................................... 930
Solve(bool, SolveConfiguration) .............................................................................................. 930
Solve(bool, string) ................................................................................................................... 930
ValueForResultTracking(uint, string) ........................................................................................ 931
ValueForSolutionTracking(uint, string) ..................................................................................... 931
SolutionCombination ................................................................................................................... 932
Children ................................................................................................................................. 934
Comments .............................................................................................................................. 934
DataModelObjectCategory ..................................................................................................... 934
Definition ............................................................................................................................... 935
Images ................................................................................................................................... 935
InternalObject ........................................................................................................................ 935
AddBeamTool() ....................................................................................................................... 935
AddComment() ....................................................................................................................... 935
AddContactTool() ................................................................................................................... 935
AddDirectionalAcceleration() .................................................................................................. 936
AddDirectionalAxialForce() ..................................................................................................... 936
AddDirectionalBendingMoment() ........................................................................................... 936
AddDirectionalDeformation() .................................................................................................. 936
AddDirectionalShearForce() .................................................................................................... 936
AddDirectionalTorsionalMoment() .......................................................................................... 936
AddDirectionalVelocity() ......................................................................................................... 937
AddElasticStrainIntensity() ...................................................................................................... 937
AddEquivalentElasticStrain() ................................................................................................... 937

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

AddEquivalentElasticStrainRST() .............................................................................................. 937

AddEquivalentStress() ............................................................................................................. 937
AddEquivalentTotalStrain() ..................................................................................................... 937
AddFatigueTool() .................................................................................................................... 938
AddImage(string) ................................................................................................................... 938
AddLinearizedEquivalentStress() ............................................................................................. 938
AddLinearizedMaximumPrincipalStress() ................................................................................. 938
AddLinearizedMaximumShearStress() ..................................................................................... 938
AddLinearizedMiddlePrincipalStress() ..................................................................................... 939
AddLinearizedMinimumPrincipalStress() ................................................................................. 939
AddLinearizedNormalStress() .................................................................................................. 939
AddLinearizedShearStress() ..................................................................................................... 939
AddLinearizedStressIntensity() ................................................................................................ 939
AddMaximumPrincipalElasticStrain() ....................................................................................... 939
AddMaximumPrincipalStress() ................................................................................................ 940
AddMaximumShearElasticStrain() ........................................................................................... 940
AddMaximumShearStress() ..................................................................................................... 940
AddMiddlePrincipalElasticStrain() ............................................................................................ 940
AddMiddlePrincipalStress() ..................................................................................................... 940
AddMinimumPrincipalElasticStrain() ....................................................................................... 940
AddMinimumPrincipalStress() ................................................................................................. 941
AddNormalElasticStrain() ........................................................................................................ 941
AddNormalStress() .................................................................................................................. 941
AddShearElasticStrain() ........................................................................................................... 941
AddShearMomentDiagramMSUM() ......................................................................................... 941
AddShearMomentDiagramMY() .............................................................................................. 941
AddShearMomentDiagramMZ() .............................................................................................. 942
AddShearMomentDiagramUSUM() .......................................................................................... 942
AddShearMomentDiagramUY() ............................................................................................... 942
AddShearMomentDiagramUZ() ............................................................................................... 942
AddShearMomentDiagramVSUM() .......................................................................................... 942
AddShearMomentDiagramVY() ............................................................................................... 942
AddShearMomentDiagramVZ() ............................................................................................... 943
AddShearStress() .................................................................................................................... 943
AddStressIntensity() ................................................................................................................ 943
AddStressTool() ...................................................................................................................... 943
AddTotalAcceleration() ........................................................................................................... 943
AddTotalAxialForce() ............................................................................................................... 943
AddTotalBendingMoment() .................................................................................................... 944
AddTotalDeformation() ........................................................................................................... 944
AddTotalShearForce() ............................................................................................................. 944
AddTotalTorsionalMoment() .................................................................................................... 944
AddTotalVelocity() .................................................................................................................. 944
AddUserDefinedResult() .......................................................................................................... 944
AddVectorAxialForce() ............................................................................................................ 945
AddVectorBendingMoment() .................................................................................................. 945
AddVectorPrincipalElasticStrain() ............................................................................................ 945
AddVectorPrincipalStress() ...................................................................................................... 945
AddVectorShearForce() ........................................................................................................... 945
AddVectorTorsionalMoment() ................................................................................................. 945
ClearGeneratedData() ............................................................................................................. 946

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

Delete() .................................................................................................................................. 946

EvaluateAllResults() ................................................................................................................. 946
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 946
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 947
SolutionCombinationDefinition .................................................................................................... 947
BaseCaseCount ....................................................................................................................... 948
LoadCombinationCount ......................................................................................................... 948
AddBaseCase(string, Analysis, double) ..................................................................................... 949
AddLoadCombination(string, int) ............................................................................................ 949
DeleteBaseCase(int) ................................................................................................................ 949
DeleteLoadCombination(int) ................................................................................................... 950
Export(string) ......................................................................................................................... 950
GetBaseCaseAnalysis(int) ........................................................................................................ 950
GetBaseCaseFrequency(int) .................................................................................................... 951
GetBaseCaseName(int) ........................................................................................................... 951
GetBaseCasePhaseAngle(int) .................................................................................................. 951
GetBaseCaseTime(int) ............................................................................................................. 952
GetCoefficient(int, int) ............................................................................................................. 952
GetLoadCombinationName(int) .............................................................................................. 952
GetLoadCombinationType(int) ................................................................................................ 952
Import(string) ......................................................................................................................... 953
SetBaseCaseAnalysis(int, Analysis) ........................................................................................... 953
SetBaseCaseFrequency(int, double) ......................................................................................... 953
SetBaseCaseName(int, string) .................................................................................................. 954
SetBaseCasePhaseAngle(int, double) ....................................................................................... 954
SetBaseCaseTime(int, double) ................................................................................................. 954
SetCoefficient(int, int, double) ................................................................................................. 955
SetLoadCombinationName(int, string) ..................................................................................... 955
SetLoadCombinationType(int, LoadCombinationType) ............................................................ 956
SolutionInformation ..................................................................................................................... 956
ActivateVisibility ..................................................................................................................... 960
Children ................................................................................................................................. 960
Comments .............................................................................................................................. 960
Component ............................................................................................................................ 960
DataModelObjectCategory ..................................................................................................... 961
Display ................................................................................................................................... 961
DisplayFilterDuringSolve ......................................................................................................... 961
DisplayPoints .......................................................................................................................... 961
DisplayType ............................................................................................................................ 961
DrawConnectionsAttachedTo ................................................................................................. 961
EnvironmentSelection ............................................................................................................ 962
Figures ................................................................................................................................... 962
IdentifyElementViolations ....................................................................................................... 962
Images ................................................................................................................................... 962
InternalObject ........................................................................................................................ 962
LineColor ................................................................................................................................ 962
LineThickness ......................................................................................................................... 963
ModeNumber ......................................................................................................................... 963
NewtonRaphsonResiduals ...................................................................................................... 963
ResponseConstraint ................................................................................................................ 963
ShowChargeResiduals ............................................................................................................. 963

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

ShowHeatResiduals ................................................................................................................ 963

ShowMomentResiduals .......................................................................................................... 964
SolutionOutput ...................................................................................................................... 964
StepNumber ........................................................................................................................... 964
StepSelectionMode ................................................................................................................ 964
SummaryType ........................................................................................................................ 964
UpdateInterval ....................................................................................................................... 964
VisibleOnResults ..................................................................................................................... 965
AddAddedMass() .................................................................................................................... 965
AddArtificialEnergy() ............................................................................................................... 965
AddChattering() ...................................................................................................................... 965
AddClosedPenetration() .......................................................................................................... 965
AddComment() ....................................................................................................................... 965
AddContactDepth() ................................................................................................................ 966
AddContactEnergy() ............................................................................................................... 966
AddContactForce() .................................................................................................................. 966
AddContactHeatFlux() ............................................................................................................ 966
AddContactingArea() .............................................................................................................. 966
AddContactMaximumNormalStiffness() .................................................................................. 966
AddContactMaxTangentialFluidPressure() ............................................................................... 967
AddContactMinimumNormalStiffness() ................................................................................... 967
AddContactPairForceConvergenceNorm() ............................................................................... 967
AddContactPressure() ............................................................................................................. 967
AddDampingEnergy() ............................................................................................................. 967
AddDeformationPlotTracker() ................................................................................................. 967
AddDensity() .......................................................................................................................... 968
AddDirectionalAcceleration() .................................................................................................. 968
AddDirectionalDeformation() .................................................................................................. 968
AddDirectionalVelocity() ......................................................................................................... 968
AddEffectiveStrain() ................................................................................................................ 968
AddEffectiveStress() ................................................................................................................ 968
AddElasticSlip() ....................................................................................................................... 969
AddErodedInternalEnergy() ..................................................................................................... 969
AddErodedKineticEnergy() ...................................................................................................... 969
AddExternalForce() ................................................................................................................. 969
AddFigure() ............................................................................................................................ 969
AddFluidPressure() .................................................................................................................. 969
AddForceReaction() ................................................................................................................ 970
AddFrictionalDissipationEnergy() ............................................................................................ 970
AddFrictionalStress() ............................................................................................................... 970
AddGap() ................................................................................................................................ 970
AddHourglassEnergy() ............................................................................................................ 970
AddImage(string) ................................................................................................................... 970
AddInternalEnergy() ............................................................................................................... 971
AddKineticEnergy() ................................................................................................................. 971
AddLatticeDensity() ................................................................................................................ 971
AddLatticeElementalDensity() ................................................................................................. 971
AddMaximumDampingPressure() ........................................................................................... 971
AddMaximumGeometricSlidingDistance() ............................................................................... 972
AddMaximumTangentialStiffness() .......................................................................................... 972
AddMinimumGeometricSlidingDistance() ............................................................................... 972

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

AddMinimumTangentialStiffness() .......................................................................................... 972

AddMomentReaction() ........................................................................................................... 972
AddMomentum() .................................................................................................................... 973
AddNonLinearStabilizationEnergy() ......................................................................................... 973
AddNumberContacting() ........................................................................................................ 973
AddNumberSticking() ............................................................................................................. 973
AddNumberWithLargePenetration() ........................................................................................ 973
AddNumberWithTooMuchSliding() ......................................................................................... 973
AddPenetration() .................................................................................................................... 974
AddPlasticWork() .................................................................................................................... 974
AddPosition() .......................................................................................................................... 974
AddPressure() ......................................................................................................................... 974
AddResultingPinball() ............................................................................................................. 974
AddRigidBodyVelocity() .......................................................................................................... 974
AddSlidingDistance() .............................................................................................................. 975
AddSlidingIndication() ............................................................................................................ 975
AddSpringTrackerDampingForce() .......................................................................................... 975
AddSpringTrackerElasticForce() ............................................................................................... 975
AddSpringTrackerElongation() ................................................................................................ 975
AddSpringTrackerVelocity() ..................................................................................................... 975
AddStabilizationEnergy() ........................................................................................................ 976
AddStiffnessEnergy() .............................................................................................................. 976
AddStrainEnergy() .................................................................................................................. 976
AddStrainPlotTracker() ............................................................................................................ 976
AddStressPlotTracker() ............................................................................................................ 976
AddTangentialDampingStress() ............................................................................................... 976
AddTemperature() .................................................................................................................. 977
AddTemperaturePlotTracker() ................................................................................................. 977
AddTopologyDensity() ............................................................................................................ 977
AddTopologyElementalDensity() ............................................................................................. 977
AddTotalEnergy() .................................................................................................................... 977
AddTotalForceFromContactPressureX() ................................................................................... 977
AddTotalForceFromContactPressureY() ................................................................................... 978
AddTotalForceFromContactPressureZ() ................................................................................... 978
AddTotalForceFromTangentialStressX() ................................................................................... 978
AddTotalForceFromTangentialStressY() ................................................................................... 978
AddTotalForceFromTangentialStressZ() ................................................................................... 978
AddTotalMassAverageVelocity() .............................................................................................. 978
AddVolumeLossDueToWear() .................................................................................................. 979
EvaluateAllContactTrackers() ................................................................................................... 979
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 979
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 979
ImportResultTrackersFromFile(string) ...................................................................................... 980
RenameBasedOnDefinition() ................................................................................................... 980
Stage ............................................................................................................................................ 980
Behavior ................................................................................................................................. 981
Children ................................................................................................................................. 982
Comments .............................................................................................................................. 982
CyclicRegion ........................................................................................................................... 982
DataModelObjectCategory ..................................................................................................... 982
Figures ................................................................................................................................... 982

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

Images ................................................................................................................................... 982

InternalObject ........................................................................................................................ 983
Location ................................................................................................................................. 983
StageName ............................................................................................................................. 983
Suppressed ............................................................................................................................ 983
AddComment() ....................................................................................................................... 983
AddFigure() ............................................................................................................................ 983
AddImage(string) ................................................................................................................... 984
Delete() .................................................................................................................................. 984
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 984
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 984
GetHarmonicIndexForEnvironmentByIndex(uint, int) ............................................................... 985
GetHarmonicIndexNumberForEnvironment(uint) .................................................................... 985
SetHarmonicIndexForEnvironmentByIndex(uint, int, uint) ........................................................ 986
SetHarmonicIndexNumberForEnvironment(uint, uint) ............................................................. 986
STL ............................................................................................................................................... 986
Color ...................................................................................................................................... 988
DataModelObjectCategory ..................................................................................................... 988
FileName ................................................................................................................................ 988
InternalObject ........................................................................................................................ 988
TranslateX .............................................................................................................................. 988
TranslateY ............................................................................................................................... 988
TranslateZ ............................................................................................................................... 989
ExportStl(string, Progress) ....................................................................................................... 989
SubstructureGenerationCondensedPart ........................................................................................ 989
AttachmentMethod ................................................................................................................ 991
DataModelObjectCategory ..................................................................................................... 991
GenerateDampingMatrix ........................................................................................................ 991
InterfaceMethod ..................................................................................................................... 991
Interfaces ............................................................................................................................... 991
InternalObject ........................................................................................................................ 991
LumpedMassFormulation ....................................................................................................... 992
PointMassTreatment ............................................................................................................... 992
ReductionMethod .................................................................................................................. 992
Surface ......................................................................................................................................... 992
Children ................................................................................................................................. 993
Comments .............................................................................................................................. 993
CoordinateSystem .................................................................................................................. 993
DataModelObjectCategory ..................................................................................................... 993
Figures ................................................................................................................................... 993
Images ................................................................................................................................... 994
InternalObject ........................................................................................................................ 994
Suppressed ............................................................................................................................ 994
AddComment() ....................................................................................................................... 994
AddFigure() ............................................................................................................................ 994
AddImage(string) ................................................................................................................... 994
Delete() .................................................................................................................................. 995
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 995
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 995
SurfaceCoating ............................................................................................................................. 996
Children ................................................................................................................................. 997

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

Comments .............................................................................................................................. 997

CoordinateSystem .................................................................................................................. 997
DataModelObjectCategory ..................................................................................................... 997
Figures ................................................................................................................................... 997
Images ................................................................................................................................... 997
InternalObject ........................................................................................................................ 998
Location ................................................................................................................................. 998
Material .................................................................................................................................. 998
Suppressed ............................................................................................................................ 998
SurfaceCoatingStiffnessBehavior ............................................................................................. 998
Thickness ............................................................................................................................... 998
AddComment() ....................................................................................................................... 999
AddFigure() ............................................................................................................................ 999
AddImage(string) ................................................................................................................... 999
Delete() .................................................................................................................................. 999
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 999
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1000
Symmetry ................................................................................................................................... 1000
Children ............................................................................................................................... 1001
Comments ............................................................................................................................ 1001
DataModelObjectCategory ................................................................................................... 1001
Figures ................................................................................................................................. 1002
Images ................................................................................................................................. 1002
InternalObject ...................................................................................................................... 1002
AddComment() ..................................................................................................................... 1002
AddCyclicRegion() ................................................................................................................ 1002
AddFigure() .......................................................................................................................... 1002
AddGeneralAxisymmetric() ................................................................................................... 1003
AddImage(string) .................................................................................................................. 1003
AddLinearPeriodicRegion() ................................................................................................... 1003
AddPeriodicRegion() ............................................................................................................. 1003
AddPreMeshedCyclicRegion() ............................................................................................... 1003
AddStage() ........................................................................................................................... 1004
AddSymmetryRegion() .......................................................................................................... 1004
Delete() ................................................................................................................................ 1004
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1004
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1004
SymmetryGeneral ....................................................................................................................... 1005
Children ............................................................................................................................... 1006
Comments ............................................................................................................................ 1006
CoordinateSystem ................................................................................................................ 1006
DataModelObjectCategory ................................................................................................... 1006
Figures ................................................................................................................................. 1006
HighBoundaryLocation ......................................................................................................... 1007
Images ................................................................................................................................. 1007
InternalObject ...................................................................................................................... 1007
Location ............................................................................................................................... 1007
LowBoundaryLocation .......................................................................................................... 1007
ScopeMode .......................................................................................................................... 1007
Suppressed ........................................................................................................................... 1008
AddComment() ..................................................................................................................... 1008

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

AddFigure() .......................................................................................................................... 1008

AddImage(string) .................................................................................................................. 1008
Delete() ................................................................................................................................ 1008
FlipHighLow() ....................................................................................................................... 1009
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1009
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1009
SymmetryManufacturingConstraint ............................................................................................ 1010
Axis ...................................................................................................................................... 1010
CoordinateSystem ................................................................................................................ 1010
DataModelObjectCategory ................................................................................................... 1011
InternalObject ...................................................................................................................... 1011
Location ............................................................................................................................... 1011
ScopingMethod .................................................................................................................... 1011
SymmetryRegion ........................................................................................................................ 1011
ApplyTo ................................................................................................................................ 1012
Behavior ............................................................................................................................... 1013
DataModelObjectCategory ................................................................................................... 1013
InternalObject ...................................................................................................................... 1013
LinearShift ............................................................................................................................ 1013
Location ............................................................................................................................... 1013
PeriodicityDirection .............................................................................................................. 1013
SymmetryNormal ................................................................................................................. 1014
Type ..................................................................................................................................... 1014
Table .......................................................................................................................................... 1014
Children ............................................................................................................................... 1015
Comments ............................................................................................................................ 1015
DataModelObjectCategory ................................................................................................... 1015
Figures ................................................................................................................................. 1015
Images ................................................................................................................................. 1016
InternalObject ...................................................................................................................... 1016
AddComment() ..................................................................................................................... 1016
AddFigure() .......................................................................................................................... 1016
AddImage(string) .................................................................................................................. 1016
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1017
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1017
GetDataURI() ........................................................................................................................ 1018
GetImportSettings() .............................................................................................................. 1018
Import(string, ImportFormat, ImportSettingsBase) ................................................................. 1018
TableGroup ................................................................................................................................. 1019
Children ............................................................................................................................... 1019
Comments ............................................................................................................................ 1019
DataModelObjectCategory ................................................................................................... 1019
Figures ................................................................................................................................. 1020
Images ................................................................................................................................. 1020
InternalObject ...................................................................................................................... 1020
AddComment() ..................................................................................................................... 1020
AddFigure() .......................................................................................................................... 1020
AddImage(string) .................................................................................................................. 1020
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1021
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1021
TCrossSection ............................................................................................................................. 1022

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

Area ..................................................................................................................................... 1022

DataModelObjectCategory ................................................................................................... 1023
InternalObject ...................................................................................................................... 1023
IYY ....................................................................................................................................... 1023
IZZ ....................................................................................................................................... 1023
Thick1 .................................................................................................................................. 1023
Thick2 .................................................................................................................................. 1023
Width1 ................................................................................................................................. 1024
Width2 ................................................................................................................................. 1024
TemperatureConstraint ............................................................................................................... 1024
DataModelObjectCategory ................................................................................................... 1024
InternalObject ...................................................................................................................... 1025
Location ............................................................................................................................... 1025
ScopingMethod .................................................................................................................... 1025
TemperatureAbsMax ............................................................................................................. 1025
ThermalComplianceConstraint .................................................................................................... 1025
ComplianceLimit .................................................................................................................. 1026
DataModelObjectCategory ................................................................................................... 1026
InternalObject ...................................................................................................................... 1026
ThermalPointMass ...................................................................................................................... 1026
AppliedBy ............................................................................................................................. 1027
Behavior ............................................................................................................................... 1027
CoordinateSystem ................................................................................................................ 1028
DataModelObjectCategory ................................................................................................... 1028
InternalObject ...................................................................................................................... 1028
PinballRegion ....................................................................................................................... 1028
Suppressed ........................................................................................................................... 1028
ThermalCapacitance ............................................................................................................. 1028
PromoteToRemotePoint() ...................................................................................................... 1029
Thickness .................................................................................................................................... 1029
Children ............................................................................................................................... 1030
Comments ............................................................................................................................ 1030
DataModelObjectCategory ................................................................................................... 1030
Figures ................................................................................................................................. 1030
Images ................................................................................................................................. 1030
IndependentVariable ............................................................................................................ 1031
InternalObject ...................................................................................................................... 1031
Location ............................................................................................................................... 1031
MembraneOffset .................................................................................................................. 1031
NumberOfSegments ............................................................................................................. 1031
OffsetType ............................................................................................................................ 1031
RangeMaximum ................................................................................................................... 1032
RangeMinimum .................................................................................................................... 1032
ScopeMode .......................................................................................................................... 1032
Suppressed ........................................................................................................................... 1032
ThicknessField ...................................................................................................................... 1032
XYZFunctionCoordinateSystem ............................................................................................. 1032
AddComment() ..................................................................................................................... 1033
AddFigure() .......................................................................................................................... 1033
AddImage(string) .................................................................................................................. 1033
Delete() ................................................................................................................................ 1033

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

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

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1034
Tree ............................................................................................................................................ 1034
ActiveObjects ....................................................................................................................... 1035
AllObjects ............................................................................................................................. 1035
CurrentFilter ......................................................................................................................... 1036
CurrentSearchGraphics ......................................................................................................... 1036
CurrentSearchState ............................................................................................................... 1036
CurrentSearchString ............................................................................................................. 1036
FirstActiveObject .................................................................................................................. 1036
GroupingFoldersVisible ......................................................................................................... 1036
Activate(IDataModelObject) .................................................................................................. 1037
Activate(IEnumerable<IDataModelObject>) .......................................................................... 1037
ClearFilter() ........................................................................................................................... 1037
ClearSort() ............................................................................................................................ 1037
Filter(string, string, ObjectState, VisibilityType, TreeFilterObjectClass, CoordinateSystem, string,
Analysis, TreeFilterScopingType, TreeFilterObjectState) ........................................................... 1038
Find(string, Func<IDataModelObject, bool>, string, ObjectState) ............................................ 1039
GetPathToFirstActiveObject() ................................................................................................ 1039
Group(IDataModelObject) ..................................................................................................... 1039
Group(IEnumerable) ............................................................................................................. 1040
IsSorted() .............................................................................................................................. 1040
Refresh() ............................................................................................................................... 1040
Sort(SortingType, bool) ......................................................................................................... 1040
Suspend() ***OBSOLETE*** Use 'Transaction' instead. ............................................................ 1041
TreeGroupingFolder .................................................................................................................... 1041
Children ............................................................................................................................... 1041
ChildrenInGroup ................................................................................................................... 1042
DataModelObjectCategory ................................................................................................... 1042
InternalObject ...................................................................................................................... 1042
Suppressed ........................................................................................................................... 1042
DeleteTreeGroupAndChildren() ............................................................................................. 1042
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1042
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1043
Ungroup() ............................................................................................................................. 1043
UniformConstraint ...................................................................................................................... 1044
Axis ...................................................................................................................................... 1044
CoordinateSystem ................................................................................................................ 1044
DataModelObjectCategory ................................................................................................... 1045
InternalObject ...................................................................................................................... 1045
Location ............................................................................................................................... 1045
ScopingMethod .................................................................................................................... 1045
UserDefinedCrossSection ............................................................................................................ 1045
Area ..................................................................................................................................... 1046
CGy ...................................................................................................................................... 1046
CGZ ...................................................................................................................................... 1046
DataModelObjectCategory ................................................................................................... 1047
InternalObject ...................................................................................................................... 1047
Iw ......................................................................................................................................... 1047
Iyy ........................................................................................................................................ 1047
Izz ........................................................................................................................................ 1047

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

J ........................................................................................................................................... 1047
SHy ....................................................................................................................................... 1048
SHz ....................................................................................................................................... 1048
VirtualCell ................................................................................................................................... 1048
Children ............................................................................................................................... 1049
Comments ............................................................................................................................ 1049
DataModelObjectCategory ................................................................................................... 1049
Figures ................................................................................................................................. 1049
Geometry ............................................................................................................................. 1049
Images ................................................................................................................................. 1049
InternalObject ...................................................................................................................... 1050
ProjectToUnderlyingGeometry .............................................................................................. 1050
VTClass ................................................................................................................................. 1050
AddComment() ..................................................................................................................... 1050
AddFigure() .......................................................................................................................... 1050
AddImage(string) .................................................................................................................. 1050
Delete() ................................................................................................................................ 1051
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1051
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1051
VirtualTopology .......................................................................................................................... 1052
AspectRatio .......................................................................................................................... 1054
AutomaticBehavior ............................................................................................................... 1054
Children ............................................................................................................................... 1054
Comments ............................................................................................................................ 1054
ContactAngle ....................................................................................................................... 1054
CustomFeatureAngle ............................................................................................................ 1054
DataModelObjectCategory ................................................................................................... 1055
EdgeAngle ............................................................................................................................ 1055
Figures ................................................................................................................................. 1055
GaussAngle .......................................................................................................................... 1055
GenerateOnUpdate .............................................................................................................. 1055
Images ................................................................................................................................. 1055
InternalObject ...................................................................................................................... 1056
LockPositionOfDependentEdgeSplits .................................................................................... 1056
MaxEdgeLength ................................................................................................................... 1056
MaxFaceArea ........................................................................................................................ 1056
MaxSliverWidth .................................................................................................................... 1056
MergeFaceEdges ................................................................................................................... 1056
Method ................................................................................................................................ 1057
MinEdgeLength .................................................................................................................... 1057
MinFaceArea ......................................................................................................................... 1057
MinSliverWidth ..................................................................................................................... 1057
RepairBehavior ..................................................................................................................... 1057
SharedBoundaryRatio ........................................................................................................... 1057
SimplifyFaces ........................................................................................................................ 1058
VirtualEdges ......................................................................................................................... 1058
VirtualEntities ....................................................................................................................... 1058
VirtualFaces .......................................................................................................................... 1058
VirtualHardVertex ................................................................................................................. 1058
VirtualSplitEdges .................................................................................................................. 1058
VirtualSplitFaces ................................................................................................................... 1059

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

AddComment() ..................................................................................................................... 1059

AddFigure() .......................................................................................................................... 1059
AddImage(string) .................................................................................................................. 1059
AddVirtualCell(ISelectionInfo) ............................................................................................... 1059
AddVirtualHardVertex(ISelectionInfo, Point) ........................................................................... 1060
Delete() ................................................................................................................................ 1060
DeleteAllVirtualCells() ........................................................................................................... 1060
DeleteAllVirtualEntities() ....................................................................................................... 1060
DeleteAllVirtualHardVertices() ............................................................................................... 1061
DeleteAllVirtualSplitEdges() .................................................................................................. 1061
DeleteAllVirtualSplitFaces() ................................................................................................... 1061
GenerateVirtualCells(ISelectionInfo) ...................................................................................... 1061
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1061
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1062
GetVirtualCellFromSelection(ISelectionInfo) .......................................................................... 1062
VirtualSplitEdge(ISelectionInfo, double) ................................................................................. 1063
VirtualSplitFaceAtVertices(ISelectionInfo) .............................................................................. 1063
VolumeConstraint ....................................................................................................................... 1063
DataModelObjectCategory ................................................................................................... 1064
DefineBy ............................................................................................................................... 1064
InternalObject ...................................................................................................................... 1064
Location ............................................................................................................................... 1065
MaximumAbsoluteValue ....................................................................................................... 1065
MinimumAbsoluteValue ....................................................................................................... 1065
PercentageToRetain .............................................................................................................. 1065
PercentageToRetainMax ....................................................................................................... 1065
PercentageToRetainMin ........................................................................................................ 1065
ScopingMethod .................................................................................................................... 1066
Selection .............................................................................................................................. 1066
Worksheet .................................................................................................................................. 1066
ZCrossSection ............................................................................................................................. 1066
Area ..................................................................................................................................... 1067
DataModelObjectCategory ................................................................................................... 1067
InternalObject ...................................................................................................................... 1067
IYY ....................................................................................................................................... 1067
IZZ ....................................................................................................................................... 1068
Thick1 .................................................................................................................................. 1068
Thick2 .................................................................................................................................. 1068
Thick3 .................................................................................................................................. 1068
Width1 ................................................................................................................................. 1068
Width2 ................................................................................................................................. 1068
Width3 ................................................................................................................................. 1069
Ansys.ACT.Automation.Mechanical.FE Namespace ....................................................................... 1071
Command .................................................................................................................................. 1071
Index .................................................................................................................................... 1071
Name ................................................................................................................................... 1071
CommandColl ............................................................................................................................. 1072
Count ................................................................................................................................... 1072
Item(uint) ............................................................................................................................. 1072
CommandRepository .................................................................................................................. 1072
GetCommandByIndex(int) .................................................................................................... 1073

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

GetCommandName(CommandsType, int) .............................................................................. 1073

GetCommandNames(CommandsType) ................................................................................. 1074
GetCommandNamesCount(CommandsType) ........................................................................ 1074
GetCommandsByName(string) .............................................................................................. 1074
CommandsType .......................................................................................................................... 1074
FEParser ...................................................................................................................................... 1075
FEParser() ............................................................................................................................. 1075
Ansys.ACT.Automation.Mechanical.FE.NASTRAN Namespace ...................................................... 1077
CaseControlCommand ................................................................................................................ 1077
Text ...................................................................................................................................... 1077
GenericCommand ....................................................................................................................... 1078
Arguments ........................................................................................................................... 1078
NastranOption ............................................................................................................................ 1078
NastranOptionLine ..................................................................................................................... 1078
OptionsControlCommand ........................................................................................................... 1079
Arguments ........................................................................................................................... 1079
OptionLines .......................................................................................................................... 1079
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace ............................................................... 1081
BeamSecBlockCommand ............................................................................................................ 1082
Cells ..................................................................................................................................... 1083
Nodes ................................................................................................................................... 1083
Type ..................................................................................................................................... 1083
BFBlockCommand ...................................................................................................................... 1083
Lab ....................................................................................................................................... 1084
NodalBodyForceCount .......................................................................................................... 1084
NodalBodyForces .................................................................................................................. 1084
BFCommand ............................................................................................................................... 1084
Lab ....................................................................................................................................... 1085
Node .................................................................................................................................... 1085
ValCount ............................................................................................................................... 1085
Values ................................................................................................................................... 1085
BFEBlockCommand ..................................................................................................................... 1085
ElementBodyForceCount ...................................................................................................... 1086
ElementBodyForces .............................................................................................................. 1086
Lab ....................................................................................................................................... 1086
BFECommand ............................................................................................................................. 1086
Elem ..................................................................................................................................... 1087
Lab ....................................................................................................................................... 1087
Stloc ..................................................................................................................................... 1087
ValCount ............................................................................................................................... 1087
Values ................................................................................................................................... 1088
CECMODCommand .................................................................................................................... 1088
Constant ............................................................................................................................... 1088
Nce ....................................................................................................................................... 1088
CECommand .............................................................................................................................. 1089
Constant ............................................................................................................................... 1089
Nce ....................................................................................................................................... 1089
Terms ................................................................................................................................... 1089
CMBlockCommand ..................................................................................................................... 1090
Cmname ............................................................................................................................... 1090
Elements .............................................................................................................................. 1090

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

Type ..................................................................................................................................... 1090

CMEDITCommand ...................................................................................................................... 1091
Aname ................................................................................................................................. 1091
Cnames ................................................................................................................................ 1091
Oper ..................................................................................................................................... 1091
CMGRPCommand ....................................................................................................................... 1092
Aname ................................................................................................................................. 1092
Cnames ................................................................................................................................ 1092
CommandCell ............................................................................................................................. 1092
MatId .................................................................................................................................... 1093
Nodes ................................................................................................................................... 1093
CommandCETerm ....................................................................................................................... 1093
Coefficient ............................................................................................................................ 1093
Dof ....................................................................................................................................... 1093
Node .................................................................................................................................... 1094
CommandElement ...................................................................................................................... 1094
Csys ...................................................................................................................................... 1094
Id ......................................................................................................................................... 1094
Mat ...................................................................................................................................... 1095
NodeCount ........................................................................................................................... 1095
Nodes ................................................................................................................................... 1095
Real ...................................................................................................................................... 1095
Section ................................................................................................................................. 1095
Type ..................................................................................................................................... 1095
CommandElementBodyForce ...................................................................................................... 1096
Count ................................................................................................................................... 1096
Elem ..................................................................................................................................... 1096
Stlocs ................................................................................................................................... 1096
Values ................................................................................................................................... 1096
CommandElementSurfaceLoad ................................................................................................... 1097
Count ................................................................................................................................... 1097
Elem ..................................................................................................................................... 1097
ElementSurfaceLoadValues ................................................................................................... 1097
Keys ..................................................................................................................................... 1098
LKeys .................................................................................................................................... 1098
CommandElementSurfaceLoadValues ......................................................................................... 1098
ValueCount ........................................................................................................................... 1098
Values ................................................................................................................................... 1098
CommandKeyOpt ....................................................................................................................... 1099
Knum ................................................................................................................................... 1099
Value .................................................................................................................................... 1099
CommandLayer .......................................................................................................................... 1099
Mat ...................................................................................................................................... 1100
Numpt .................................................................................................................................. 1100
Theta .................................................................................................................................... 1100
Thick .................................................................................................................................... 1100
CommandNodalBodyForce ......................................................................................................... 1100
Node .................................................................................................................................... 1101
ValCount ............................................................................................................................... 1101
Values ................................................................................................................................... 1101
CommandNode .......................................................................................................................... 1101

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

Id ......................................................................................................................................... 1101
Location ............................................................................................................................... 1102
Rotation ............................................................................................................................... 1102
CommandReal ............................................................................................................................ 1102
Id ......................................................................................................................................... 1102
Values ................................................................................................................................... 1102
CPCommand .............................................................................................................................. 1103
Dof ....................................................................................................................................... 1103
Ncp ...................................................................................................................................... 1103
Nodes ................................................................................................................................... 1103
EBlockCommand ........................................................................................................................ 1104
Elements .............................................................................................................................. 1104
ENCommand .............................................................................................................................. 1104
Type ..................................................................................................................................... 1105
Values ................................................................................................................................... 1105
ETCommand ............................................................................................................................... 1105
Ename .................................................................................................................................. 1105
Id ......................................................................................................................................... 1106
Keyopts ................................................................................................................................ 1106
GenericCommand ....................................................................................................................... 1106
Arguments ........................................................................................................................... 1106
LocalCommand .......................................................................................................................... 1106
Cstyp .................................................................................................................................... 1107
Ncsy ..................................................................................................................................... 1107
Type ..................................................................................................................................... 1107
Values ................................................................................................................................... 1107
MPCommand ............................................................................................................................. 1108
C0 ........................................................................................................................................ 1108
C1 ........................................................................................................................................ 1108
C2 ........................................................................................................................................ 1109
C3 ........................................................................................................................................ 1109
C4 ........................................................................................................................................ 1109
Lab ....................................................................................................................................... 1109
Mat ...................................................................................................................................... 1109
MPDataCommand ...................................................................................................................... 1109
Lab ....................................................................................................................................... 1110
Mat ...................................................................................................................................... 1110
Temps .................................................................................................................................. 1110
Values ................................................................................................................................... 1110
NBlockCommand ........................................................................................................................ 1111
Nodes ................................................................................................................................... 1111
NCommand ................................................................................................................................ 1111
Node .................................................................................................................................... 1112
Type ..................................................................................................................................... 1112
Values ................................................................................................................................... 1112
PreadCommand .......................................................................................................................... 1112
Aname ................................................................................................................................. 1113
Values ................................................................................................................................... 1113
RCommand ................................................................................................................................ 1113
Nset ...................................................................................................................................... 1113
Stloc ..................................................................................................................................... 1114

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

Values ................................................................................................................................... 1114

RLBlockCommand ...................................................................................................................... 1114
Reals ..................................................................................................................................... 1114
SecdataCommand ...................................................................................................................... 1115
Values ................................................................................................................................... 1115
SecoffsetCommand .................................................................................................................... 1115
Location ............................................................................................................................... 1116
Values ................................................................................................................................... 1116
SectypeCommand ...................................................................................................................... 1116
RefineKey ............................................................................................................................. 1116
Secid .................................................................................................................................... 1117
Secname .............................................................................................................................. 1117
Subtype ................................................................................................................................ 1117
Type ..................................................................................................................................... 1117
SFEBlockCommand ..................................................................................................................... 1117
ElementSurfaceLoadCount ................................................................................................... 1118
ElementSurfaceLoads ........................................................................................................... 1118
Lab ....................................................................................................................................... 1118
SFECommand ............................................................................................................................. 1118
Elem ..................................................................................................................................... 1119
Key ....................................................................................................................................... 1119
Lab ....................................................................................................................................... 1119
LKey ..................................................................................................................................... 1119
Values ................................................................................................................................... 1119
ShellSecBlockCommand ............................................................................................................. 1120
Layers ................................................................................................................................... 1120
Type ..................................................................................................................................... 1120
TBDataCommand ....................................................................................................................... 1120
DataValueCount .................................................................................................................... 1121
DataValues ........................................................................................................................... 1121
Lab ....................................................................................................................................... 1121
Mat ...................................................................................................................................... 1121
Npts ..................................................................................................................................... 1122
Ntemp .................................................................................................................................. 1122
Tbopt ................................................................................................................................... 1122
TBDataValues .............................................................................................................................. 1122
Temp .................................................................................................................................... 1122
ValueCount ........................................................................................................................... 1123
Values ................................................................................................................................... 1123
TBPTCommand ........................................................................................................................... 1123
Lab ....................................................................................................................................... 1123
Mat ...................................................................................................................................... 1124
Npts ..................................................................................................................................... 1124
Ntemp .................................................................................................................................. 1124
Tbopt ................................................................................................................................... 1124
TBPTData .............................................................................................................................. 1124
TBPTDataCount .................................................................................................................... 1124
TBPTData .................................................................................................................................... 1125
TBPTCount ............................................................................................................................ 1125
TBPTValues ........................................................................................................................... 1125
Temp .................................................................................................................................... 1125

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

TBPTValues ................................................................................................................................. 1125

ValueCount ........................................................................................................................... 1126
Values ................................................................................................................................... 1126
Ansys.ACT.Automation.Mechanical.FE.ABAQUS Namespace ........................................................ 1127
AbaqusKeyword ......................................................................................................................... 1127
Arguments ........................................................................................................................... 1127
DataLines ............................................................................................................................. 1128
AbaqusKeywordArgument .......................................................................................................... 1128
Key ....................................................................................................................................... 1128
Value .................................................................................................................................... 1128
AbaqusKeywordArgumentColl .................................................................................................... 1128
Items .................................................................................................................................... 1129
AbaqusKeywordDataLine ............................................................................................................ 1129
Items .................................................................................................................................... 1129
AbaqusKeywordDataLineColl ...................................................................................................... 1129
Items .................................................................................................................................... 1130
Ansys.ACT.Automation.Mechanical.Results Namespace ............................................................... 1131
Alert ........................................................................................................................................... 1132
Children ............................................................................................................................... 1132
Comments ............................................................................................................................ 1132
DataModelObjectCategory ................................................................................................... 1133
FailsIf .................................................................................................................................... 1133
Images ................................................................................................................................. 1133
InternalObject ...................................................................................................................... 1133
Status ................................................................................................................................... 1133
Value .................................................................................................................................... 1133
AddComment() ..................................................................................................................... 1134
AddImage(string) .................................................................................................................. 1134
Delete() ................................................................................................................................ 1134
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1134
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1135
ContactDataTable ....................................................................................................................... 1135
Children ............................................................................................................................... 1136
Comments ............................................................................................................................ 1136
DataModelObjectCategory ................................................................................................... 1136
Figures ................................................................................................................................. 1136
InternalObject ...................................................................................................................... 1136
AddComment() ..................................................................................................................... 1137
AddFigure() .......................................................................................................................... 1137
Delete() ................................................................................................................................ 1137
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1137
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1137
Convergence .............................................................................................................................. 1138
AllowableChange ................................................................................................................. 1139
Children ............................................................................................................................... 1139
Comments ............................................................................................................................ 1139
DataModelObjectCategory ................................................................................................... 1139
Figures ................................................................................................................................. 1139
Images ................................................................................................................................. 1140
InternalObject ...................................................................................................................... 1140
IsConverged ......................................................................................................................... 1140

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

LastChange .......................................................................................................................... 1140

Type ..................................................................................................................................... 1140
AddComment() ..................................................................................................................... 1140
AddFigure() .......................................................................................................................... 1141
AddImage(string) .................................................................................................................. 1141
Delete() ................................................................................................................................ 1141
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1141
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1142
LatticeDensity ............................................................................................................................. 1142
DataModelObjectCategory ................................................................................................... 1144
InternalObject ...................................................................................................................... 1144
LatticeElementalDensity ............................................................................................................. 1144
DataModelObjectCategory ................................................................................................... 1146
InternalObject ...................................................................................................................... 1147
LinePressureResult ...................................................................................................................... 1147
DataModelObjectCategory ................................................................................................... 1150
InternalObject ...................................................................................................................... 1150
LinePressureResultBasedOn .................................................................................................. 1151
MagneticCoenergy ..................................................................................................................... 1151
DataModelObjectCategory ................................................................................................... 1154
InternalObject ...................................................................................................................... 1154
MagneticPotential ...................................................................................................................... 1155
DataModelObjectCategory ................................................................................................... 1158
InternalObject ...................................................................................................................... 1158
NewtonRaphsonResidualCharge ................................................................................................. 1158
DataModelObjectCategory ................................................................................................... 1162
InternalObject ...................................................................................................................... 1162
NewtonRaphsonResidualForce .................................................................................................... 1162
DataModelObjectCategory ................................................................................................... 1166
InternalObject ...................................................................................................................... 1166
NewtonRaphsonResidualHeat ..................................................................................................... 1166
DataModelObjectCategory ................................................................................................... 1169
InternalObject ...................................................................................................................... 1170
NewtonRaphsonResidualMoment ............................................................................................... 1170
DataModelObjectCategory ................................................................................................... 1173
InternalObject ...................................................................................................................... 1173
Result ......................................................................................................................................... 1174
Average ................................................................................................................................ 1176
By ......................................................................................................................................... 1176
CalculateTimeHistory ............................................................................................................ 1176
Children ............................................................................................................................... 1176
CombinationNumber ............................................................................................................ 1177
Comments ............................................................................................................................ 1177
CoordinateSystem ................................................................................................................ 1177
DataModelObjectCategory ................................................................................................... 1177
DisplayOption ....................................................................................................................... 1177
DisplayTime .......................................................................................................................... 1178
DpfEvaluation ....................................................................................................................... 1178
Figures ................................................................................................................................. 1178
GlobalIDs .............................................................................................................................. 1178
GraphControlsXAxis .............................................................................................................. 1178

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

Identifier ............................................................................................................................... 1178

Images ................................................................................................................................. 1179
InternalObject ...................................................................................................................... 1179
IsSolved ................................................................................................................................ 1179
ItemType .............................................................................................................................. 1179
IterationNumber ................................................................................................................... 1179
LoadStep .............................................................................................................................. 1179
LoadStepForMaximumOfMaximumValues ............................................................................. 1180
LoadStepForMaximumOfMinimumValues ............................................................................. 1180
LoadStepForMinimumOfMaximumValues ............................................................................. 1180
LoadStepForMinimumOfMinimumValues .............................................................................. 1180
LoadStepNumber ................................................................................................................. 1180
Location ............................................................................................................................... 1180
Maximum ............................................................................................................................. 1181
MaximumOccursOn .............................................................................................................. 1181
MaximumOfMaximumOverTime ........................................................................................... 1181
MaximumOfMinimumOverTime ............................................................................................ 1181
Minimum .............................................................................................................................. 1181
MinimumOccursOn .............................................................................................................. 1181
MinimumOfMaximumOverTime ............................................................................................ 1182
MinimumOfMinimumOverTime ............................................................................................ 1182
PlotData ............................................................................................................................... 1182
ScopingMethod .................................................................................................................... 1182
SetNumber ........................................................................................................................... 1182
SolutionCombinationDriver .................................................................................................. 1182
SolverComponentIDs ............................................................................................................ 1183
Substep ................................................................................................................................ 1183
Suppressed ........................................................................................................................... 1183
Surface ................................................................................................................................. 1183
Time ..................................................................................................................................... 1183
TimeForMaximumOfMaximumValues .................................................................................... 1183
TimeForMaximumOfMinimumValues .................................................................................... 1184
TimeForMinimumOfMaximumValues .................................................................................... 1184
TimeForMinimumOfMinimumValues ..................................................................................... 1184
AddAlert() ............................................................................................................................. 1184
AddComment() ..................................................................................................................... 1184
AddConvergence() ................................................................................................................ 1184
AddFigure() .......................................................................................................................... 1185
AddImage(string) .................................................................................................................. 1185
ClearGeneratedData() ........................................................................................................... 1185
CreateResultsAtAllSets() ........................................................................................................ 1185
Delete() ................................................................................................................................ 1185
DuplicateWithoutResults() .................................................................................................... 1186
EvaluateAllResults() ............................................................................................................... 1186
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1186
ExportToTextFile(string) ........................................................................................................ 1186
FetchRemoteResults() ........................................................................................................... 1187
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1187
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1187
PromoteToNamedSelection() ................................................................................................ 1188
RenameBasedOnDefinition() ................................................................................................. 1188

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

ResultChart ................................................................................................................................. 1188

AccelerationType .................................................................................................................. 1190
BoundaryCondition .............................................................................................................. 1190
ChartDimensions .................................................................................................................. 1190
ChartViewingStyle ................................................................................................................ 1190
Children ............................................................................................................................... 1191
Comments ............................................................................................................................ 1191
CoordinateSystem ................................................................................................................ 1191
CurvesAppearanceDisplay .................................................................................................... 1191
CutFrequency ....................................................................................................................... 1191
DataModelObjectCategory ................................................................................................... 1191
DeformationType .................................................................................................................. 1192
DpfEvaluation ....................................................................................................................... 1192
Duration ............................................................................................................................... 1192
EnhancedTracking ................................................................................................................ 1192
FilterMaximum ..................................................................................................................... 1192
FilterMinimum ...................................................................................................................... 1192
FilterType ............................................................................................................................. 1193
FrequencyAtMaximumAmplitude ......................................................................................... 1193
GeometrySelectionString ...................................................................................................... 1193
Images ................................................................................................................................. 1193
ImaginaryAtMaximumAmplitude .......................................................................................... 1193
InternalObject ...................................................................................................................... 1193
IsSolved ................................................................................................................................ 1194
LoadStepNumber ................................................................................................................. 1194
Location ............................................................................................................................... 1194
Maximum ............................................................................................................................. 1194
MaximumAmplitude ............................................................................................................. 1194
MaximumFrequency ............................................................................................................. 1194
Minimum .............................................................................................................................. 1195
MinimumFrequency ............................................................................................................. 1195
NormalOrientation ................................................................................................................ 1195
PhaseAngle .......................................................................................................................... 1195
RealAtMaximumAmplitude ................................................................................................... 1195
ReportedFrequency .............................................................................................................. 1195
RequestedFrequency ............................................................................................................ 1196
ResultChartType ................................................................................................................... 1196
SectorNumber ...................................................................................................................... 1196
ShearOrientation .................................................................................................................. 1196
SpatialResolution .................................................................................................................. 1196
Spring .................................................................................................................................. 1196
StressStrainType ................................................................................................................... 1197
Suppressed ........................................................................................................................... 1197
TimeHistoryDisplay ............................................................................................................... 1197
UseParentFrequencyRange ................................................................................................... 1197
VelocityType ......................................................................................................................... 1197
XAxisValues .......................................................................................................................... 1197
AddComment() ..................................................................................................................... 1198
AddImage(string) .................................................................................................................. 1198
ClearGeneratedData() ........................................................................................................... 1198
Delete() ................................................................................................................................ 1198

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

EvaluateAllResults() ............................................................................................................... 1198

ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1199
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1199
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1199
RenameBasedOnDefinition() ................................................................................................. 1200
ResultTable ................................................................................................................................. 1200
Children ............................................................................................................................... 1201
Comments ............................................................................................................................ 1201
DataModelObjectCategory ................................................................................................... 1201
Images ................................................................................................................................. 1201
InternalObject ...................................................................................................................... 1201
Multiplier .............................................................................................................................. 1202
AddComment() ..................................................................................................................... 1202
AddImage(string) .................................................................................................................. 1202
Delete() ................................................................................................................................ 1202
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1202
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1203
ShapeFinder ............................................................................................................................... 1203
DataModelObjectCategory ................................................................................................... 1207
InternalObject ...................................................................................................................... 1207
ShapeFinderElemental ................................................................................................................ 1207
DataModelObjectCategory ................................................................................................... 1210
InternalObject ...................................................................................................................... 1211
Smoothing ................................................................................................................................. 1211
DataModelObjectCategory ................................................................................................... 1212
ExportModel ......................................................................................................................... 1212
FileName .............................................................................................................................. 1212
InternalObject ...................................................................................................................... 1212
MoveLimit ............................................................................................................................ 1213
Evaluate() ............................................................................................................................. 1213
TopologyDensity ........................................................................................................................ 1213
DataModelObjectCategory ................................................................................................... 1215
InternalObject ...................................................................................................................... 1215
RetainedThreshold ................................................................................................................ 1215
AddSmoothing() ................................................................................................................... 1215
InsertSmoothing() ................................................................................................................. 1216
TopologyElementalDensity ......................................................................................................... 1216
DataModelObjectCategory ................................................................................................... 1218
InternalObject ...................................................................................................................... 1218
RetainedThreshold ................................................................................................................ 1218
TopologyOptimizationResult ....................................................................................................... 1218
CalculateTimeHistory ............................................................................................................ 1220
Children ............................................................................................................................... 1220
Comments ............................................................................................................................ 1220
DataModelObjectCategory ................................................................................................... 1220
ExclusionsParticipation ......................................................................................................... 1220
Figures ................................................................................................................................. 1220
FinalMass .............................................................................................................................. 1221
FinalVolume .......................................................................................................................... 1221
Images ................................................................................................................................. 1221
InternalObject ...................................................................................................................... 1221

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

IterationNumber ................................................................................................................... 1221

IterationStep ......................................................................................................................... 1221
Location ............................................................................................................................... 1222
Maximum ............................................................................................................................. 1222
Minimum .............................................................................................................................. 1222
OriginalMass ......................................................................................................................... 1222
OriginalVolume ..................................................................................................................... 1222
PercentMassOfOriginal ......................................................................................................... 1222
PercentVolumeOfOriginal ..................................................................................................... 1223
ScopingMethod .................................................................................................................... 1223
Selection .............................................................................................................................. 1223
ShowOptimizedRegion ......................................................................................................... 1223
Suppressed ........................................................................................................................... 1223
AddComment() ..................................................................................................................... 1223
AddFigure() .......................................................................................................................... 1224
AddImage(string) .................................................................................................................. 1224
ClearGeneratedData() ........................................................................................................... 1224
Delete() ................................................................................................................................ 1224
EvaluateAllResults() ............................................................................................................... 1224
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1225
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1225
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1225
RenameBasedOnDefinition() ................................................................................................. 1226
UserDefinedResult ...................................................................................................................... 1226
Average ................................................................................................................................ 1228
AverageAcrossBodies ............................................................................................................ 1228
By ......................................................................................................................................... 1229
CalculateTimeHistory ............................................................................................................ 1229
Children ............................................................................................................................... 1229
CombinationNumber ............................................................................................................ 1229
CoordinateSystem ................................................................................................................ 1229
CyclicMode ........................................................................................................................... 1230
DataModelObjectCategory ................................................................................................... 1230
DisplayOption ....................................................................................................................... 1230
DisplayTime .......................................................................................................................... 1230
Expression ............................................................................................................................ 1230
GlobalIDs .............................................................................................................................. 1230
GraphControlsXAxis .............................................................................................................. 1231
Identifier ............................................................................................................................... 1231
InputUnitSystem ................................................................................................................... 1231
InternalObject ...................................................................................................................... 1231
IsSolved ................................................................................................................................ 1231
ItemType .............................................................................................................................. 1231
IterationNumber ................................................................................................................... 1232
Layer .................................................................................................................................... 1232
LoadMultiplier ...................................................................................................................... 1232
LoadStep .............................................................................................................................. 1232
LoadStepNumber ................................................................................................................. 1232
Location ............................................................................................................................... 1232
Maximum ............................................................................................................................. 1233
MaximumOccursOn .............................................................................................................. 1233

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

MaximumOfMaximumOverTime ........................................................................................... 1233

MaximumOfMinimumOverTime ............................................................................................ 1233
Minimum .............................................................................................................................. 1233
MinimumOccursOn .............................................................................................................. 1233
MinimumOfMaximumOverTime ............................................................................................ 1234
MinimumOfMinimumOverTime ............................................................................................ 1234
Mode .................................................................................................................................... 1234
OutputUnit ........................................................................................................................... 1234
PhaseIncrement .................................................................................................................... 1234
Plies ..................................................................................................................................... 1234
PlotData ............................................................................................................................... 1235
Ply ........................................................................................................................................ 1235
Position ................................................................................................................................ 1235
ReportedFrequency .............................................................................................................. 1235
RequestedFrequency ............................................................................................................ 1235
ResponseType ...................................................................................................................... 1235
ScaleFactor ........................................................................................................................... 1236
ScaleFactorValue ................................................................................................................... 1236
ScopingMethod .................................................................................................................... 1236
SetNumber ........................................................................................................................... 1236
SolutionCombinationDriver .................................................................................................. 1236
SolverComponentIDs ............................................................................................................ 1236
SubScopeBy ......................................................................................................................... 1237
Substep ................................................................................................................................ 1237
Suppressed ........................................................................................................................... 1237
SweepingPhase .................................................................................................................... 1237
Time ..................................................................................................................................... 1237
Type ..................................................................................................................................... 1237
ClearGeneratedData() ........................................................................................................... 1238
CreateResultsAtAllSets() ........................................................................................................ 1238
Delete() ................................................................................................................................ 1238
DuplicateWithoutResults() .................................................................................................... 1238
EvaluateAllResults() ............................................................................................................... 1238
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1238
ExportToTextFile(string) ........................................................................................................ 1239
FetchRemoteResults() ........................................................................................................... 1239
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1239
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1240
PromoteToNamedSelection() ................................................................................................ 1240
RenameBasedOnDefinition() ................................................................................................. 1240
VariableGraph ............................................................................................................................. 1241
DataModelObjectCategory ................................................................................................... 1244
InternalObject ...................................................................................................................... 1244
Volume ....................................................................................................................................... 1244
Amplitude ............................................................................................................................ 1248
DataModelObjectCategory ................................................................................................... 1248
Frequency ............................................................................................................................ 1248
InternalObject ...................................................................................................................... 1248
PhaseIncrement .................................................................................................................... 1249
SweepingPhase .................................................................................................................... 1249
Total ..................................................................................................................................... 1249

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

Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace ......................... 1251

AccelerationPhaseResponse ........................................................................................................ 1251
ContactRegion ...................................................................................................................... 1254
DataModelObjectCategory ................................................................................................... 1254
InternalObject ...................................................................................................................... 1254
DeformationPhaseResponse ....................................................................................................... 1255
DataModelObjectCategory ................................................................................................... 1258
InternalObject ...................................................................................................................... 1258
ElasticStrainPhaseResponse ........................................................................................................ 1258
ContactRegion ...................................................................................................................... 1261
DataModelObjectCategory ................................................................................................... 1261
InternalObject ...................................................................................................................... 1261
StressPhaseResponse .................................................................................................................. 1262
DataModelObjectCategory ................................................................................................... 1265
InternalObject ...................................................................................................................... 1265
VelocityPhaseResponse ............................................................................................................... 1265
ContactRegion ...................................................................................................................... 1268
DataModelObjectCategory ................................................................................................... 1268
InternalObject ...................................................................................................................... 1268
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace ......................................... 1269
AccumulatedEquivalentPlasticStrain ........................................................................................... 1269
DataModelObjectCategory ................................................................................................... 1274
InternalObject ...................................................................................................................... 1274
DirectionalThermalStrain ............................................................................................................ 1274
DataModelObjectCategory ................................................................................................... 1279
InternalObject ...................................................................................................................... 1279
NormalOrientation ................................................................................................................ 1279
ElasticStrainIntensity ................................................................................................................... 1279
DataModelObjectCategory ................................................................................................... 1284
InternalObject ...................................................................................................................... 1284
EquivalentCreepStrain ................................................................................................................ 1284
DataModelObjectCategory ................................................................................................... 1289
InternalObject ...................................................................................................................... 1289
EquivalentCreepStrainRST ........................................................................................................... 1289
DataModelObjectCategory ................................................................................................... 1294
InternalObject ...................................................................................................................... 1294
EquivalentElasticStrain ................................................................................................................ 1294
DataModelObjectCategory ................................................................................................... 1299
InternalObject ...................................................................................................................... 1299
EquivalentElasticStrainRST .......................................................................................................... 1299
DataModelObjectCategory ................................................................................................... 1303
InternalObject ...................................................................................................................... 1304
EquivalentPlasticStrain ................................................................................................................ 1304
DataModelObjectCategory ................................................................................................... 1308
InternalObject ...................................................................................................................... 1308
EquivalentPlasticStrainRST .......................................................................................................... 1309
DataModelObjectCategory ................................................................................................... 1313
InternalObject ...................................................................................................................... 1313
EquivalentTotalStrain .................................................................................................................. 1313
DataModelObjectCategory ................................................................................................... 1318
InternalObject ...................................................................................................................... 1318

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

MaximumPrincipalElasticStrain ................................................................................................... 1318

DataModelObjectCategory ................................................................................................... 1323
InternalObject ...................................................................................................................... 1323
Layer .................................................................................................................................... 1323
NormalOrientation ................................................................................................................ 1323
MaximumPrincipalThermalStrain ................................................................................................ 1324
DataModelObjectCategory ................................................................................................... 1328
InternalObject ...................................................................................................................... 1328
MaximumShearElasticStrain ........................................................................................................ 1328
DataModelObjectCategory ................................................................................................... 1333
InternalObject ...................................................................................................................... 1333
ShearOrientation .................................................................................................................. 1333
MiddlePrincipalElasticStrain ........................................................................................................ 1333
DataModelObjectCategory ................................................................................................... 1338
InternalObject ...................................................................................................................... 1338
MiddlePrincipalThermalStrain ..................................................................................................... 1338
DataModelObjectCategory ................................................................................................... 1343
InternalObject ...................................................................................................................... 1343
MinimumPrincipalElasticStrain .................................................................................................... 1343
DataModelObjectCategory ................................................................................................... 1348
InternalObject ...................................................................................................................... 1348
NormalElasticStrain ..................................................................................................................... 1348
DataModelObjectCategory ................................................................................................... 1353
InternalObject ...................................................................................................................... 1353
NormalOrientation ................................................................................................................ 1353
ScaleFactor ........................................................................................................................... 1353
ScaleFactorValue ................................................................................................................... 1353
ShearElasticStrain ....................................................................................................................... 1353
DataModelObjectCategory ................................................................................................... 1358
InternalObject ...................................................................................................................... 1358
ScaleFactor ........................................................................................................................... 1358
ScaleFactorValue ................................................................................................................... 1359
ShearOrientation .................................................................................................................. 1359
StrainResult ................................................................................................................................ 1359
Amplitude ............................................................................................................................ 1363
AverageAcrossBodies ............................................................................................................ 1363
CyclicMode ........................................................................................................................... 1363
DataModelObjectCategory ................................................................................................... 1363
EnvironmentSelection ........................................................................................................... 1363
Frequency ............................................................................................................................ 1364
HarmonicIndex ..................................................................................................................... 1364
InternalObject ...................................................................................................................... 1364
IterationStep ......................................................................................................................... 1364
LoadMultiplier ...................................................................................................................... 1364
Mode .................................................................................................................................... 1364
PhaseIncrement .................................................................................................................... 1365
Plies ..................................................................................................................................... 1365
Ply ........................................................................................................................................ 1365
Position ................................................................................................................................ 1365
ReportedFrequency .............................................................................................................. 1365
StressStrainType ................................................................................................................... 1365

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

SubScopeBy ......................................................................................................................... 1366

SweepingPhase .................................................................................................................... 1366
VectorPrincipalElasticStrain ......................................................................................................... 1366
DataModelObjectCategory ................................................................................................... 1370
InternalObject ...................................................................................................................... 1371
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace .............................. 1373
DeformationResult ...................................................................................................................... 1373
AccelerationInG .................................................................................................................... 1377
AllowPhaseSweep ................................................................................................................. 1378
Amplitude ............................................................................................................................ 1378
CyclicMode ........................................................................................................................... 1378
CyclicPhase ........................................................................................................................... 1378
DampedFrequency ............................................................................................................... 1378
DataModelObjectCategory ................................................................................................... 1378
DeformationType .................................................................................................................. 1379
EnvironmentSelection ........................................................................................................... 1379
Frequency ............................................................................................................................ 1379
HarmonicIndex ..................................................................................................................... 1379
InternalObject ...................................................................................................................... 1379
IterationStep ......................................................................................................................... 1379
LoadMultiplier ...................................................................................................................... 1380
LogarithmicDecrement ......................................................................................................... 1380
ModalDampingRatio ............................................................................................................. 1380
Mode .................................................................................................................................... 1380
PhaseIncrement .................................................................................................................... 1380
Probability ............................................................................................................................ 1380
Reference ............................................................................................................................. 1381
ReportedFrequency .............................................................................................................. 1381
ScaleFactor ........................................................................................................................... 1381
ScaleFactorValue ................................................................................................................... 1381
Stability ................................................................................................................................ 1381
SweepingPhase .................................................................................................................... 1381
DirectionalAcceleration ............................................................................................................... 1382
DataModelObjectCategory ................................................................................................... 1386
InternalObject ...................................................................................................................... 1387
NormalOrientation ................................................................................................................ 1387
DirectionalAccelerationPSD ........................................................................................................ 1387
DataModelObjectCategory ................................................................................................... 1392
InternalObject ...................................................................................................................... 1392
NormalOrientation ................................................................................................................ 1392
DirectionalAccelerationRS ........................................................................................................... 1392
DataModelObjectCategory ................................................................................................... 1397
InternalObject ...................................................................................................................... 1397
NormalOrientation ................................................................................................................ 1398
DirectionalDeformation .............................................................................................................. 1398
DataModelObjectCategory ................................................................................................... 1403
InternalObject ...................................................................................................................... 1403
NormalOrientation ................................................................................................................ 1403
DirectionalVelocity ...................................................................................................................... 1403
DataModelObjectCategory ................................................................................................... 1408
InternalObject ...................................................................................................................... 1408

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

NormalOrientation ................................................................................................................ 1408

DirectionalVelocityPSD ............................................................................................................... 1409
DataModelObjectCategory ................................................................................................... 1414
InternalObject ...................................................................................................................... 1414
NormalOrientation ................................................................................................................ 1414
DirectionalVelocityRS .................................................................................................................. 1414
DataModelObjectCategory ................................................................................................... 1419
InternalObject ...................................................................................................................... 1419
NormalOrientation ................................................................................................................ 1419
TotalAcceleration ........................................................................................................................ 1419
DataModelObjectCategory ................................................................................................... 1424
InternalObject ...................................................................................................................... 1424
TotalDeformation ....................................................................................................................... 1425
DataModelObjectCategory ................................................................................................... 1430
InternalObject ...................................................................................................................... 1430
TotalVelocity ............................................................................................................................... 1430
DataModelObjectCategory ................................................................................................... 1435
InternalObject ...................................................................................................................... 1435
VectorDeformation ..................................................................................................................... 1435
DataModelObjectCategory ................................................................................................... 1439
InternalObject ...................................................................................................................... 1439
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace ..................................... 1441
DamageResult ............................................................................................................................ 1441
DamageResultType ............................................................................................................... 1445
DataModelObjectCategory ................................................................................................... 1445
InternalObject ...................................................................................................................... 1445
Mode .................................................................................................................................... 1445
DamageStatus ............................................................................................................................ 1446
DataModelObjectCategory ................................................................................................... 1449
InternalObject ...................................................................................................................... 1449
EnergyDissipatedPerUnitVolume ................................................................................................. 1450
DataModelObjectCategory ................................................................................................... 1453
InternalObject ...................................................................................................................... 1453
FiberCompressiveDamageVariable .............................................................................................. 1453
DataModelObjectCategory ................................................................................................... 1457
InternalObject ...................................................................................................................... 1457
FiberCompressiveFailureCriterion ................................................................................................ 1457
DataModelObjectCategory ................................................................................................... 1461
InternalObject ...................................................................................................................... 1461
FiberTensileDamageVariable ....................................................................................................... 1461
DataModelObjectCategory ................................................................................................... 1465
InternalObject ...................................................................................................................... 1465
FiberTensileFailureCriterion ......................................................................................................... 1465
DataModelObjectCategory ................................................................................................... 1469
InternalObject ...................................................................................................................... 1469
MatrixCompressiveDamageVariable ............................................................................................ 1469
DataModelObjectCategory ................................................................................................... 1473
InternalObject ...................................................................................................................... 1473
MatrixCompressiveFailureCriterion .............................................................................................. 1473
DataModelObjectCategory ................................................................................................... 1477
InternalObject ...................................................................................................................... 1477

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

MatrixTensileDamageVariable ..................................................................................................... 1477

DataModelObjectCategory ................................................................................................... 1481
InternalObject ...................................................................................................................... 1481
MatrixTensileFailureCriterion ....................................................................................................... 1481
DataModelObjectCategory ................................................................................................... 1485
InternalObject ...................................................................................................................... 1485
MaximumFailureCriteria .............................................................................................................. 1485
DataModelObjectCategory ................................................................................................... 1489
InternalObject ...................................................................................................................... 1489
MullinsDamageVariable .............................................................................................................. 1489
DataModelObjectCategory ................................................................................................... 1493
InternalObject ...................................................................................................................... 1493
MullinsMaximumPreviousStrainEnergy ....................................................................................... 1493
DataModelObjectCategory ................................................................................................... 1497
InternalObject ...................................................................................................................... 1497
ShearDamageVariable ................................................................................................................. 1497
DataModelObjectCategory ................................................................................................... 1501
InternalObject ...................................................................................................................... 1501
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace ................... 1503
CoordinateSystemsResult ............................................................................................................ 1503
Amplitude ............................................................................................................................ 1507
DataModelObjectCategory ................................................................................................... 1507
Frequency ............................................................................................................................ 1507
InternalObject ...................................................................................................................... 1507
LoadMultiplier ...................................................................................................................... 1508
Mode .................................................................................................................................... 1508
PhaseIncrement .................................................................................................................... 1508
Ply ........................................................................................................................................ 1508
Position ................................................................................................................................ 1508
ScaleFactor ........................................................................................................................... 1508
ScaleFactorValue ................................................................................................................... 1509
SubScopeBy ......................................................................................................................... 1509
SweepingPhase .................................................................................................................... 1509
ElementalEulerXYAngle ............................................................................................................... 1509
DataModelObjectCategory ................................................................................................... 1513
InternalObject ...................................................................................................................... 1514
ElementalEulerXZAngle .............................................................................................................. 1514
DataModelObjectCategory ................................................................................................... 1518
InternalObject ...................................................................................................................... 1518
ElementalEulerYZAngle .............................................................................................................. 1519
DataModelObjectCategory ................................................................................................... 1523
InternalObject ...................................................................................................................... 1523
ElementalTriads .......................................................................................................................... 1523
DataModelObjectCategory ................................................................................................... 1528
InternalObject ...................................................................................................................... 1528
NodalEulerXYAngle ..................................................................................................................... 1528
DataModelObjectCategory ................................................................................................... 1532
InternalObject ...................................................................................................................... 1532
NodalEulerXZAngle .................................................................................................................... 1533
DataModelObjectCategory ................................................................................................... 1537
InternalObject ...................................................................................................................... 1537

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

NodalEulerYZAngle ..................................................................................................................... 1537

DataModelObjectCategory ................................................................................................... 1542
InternalObject ...................................................................................................................... 1542
NodalTriads ................................................................................................................................ 1542
DataModelObjectCategory ................................................................................................... 1546
InternalObject ...................................................................................................................... 1546
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace ........................ 1547
LinearizedEquivalentStress .......................................................................................................... 1547
DataModelObjectCategory ................................................................................................... 1553
InternalObject ...................................................................................................................... 1553
LinearizedMaximumPrincipalStress ............................................................................................. 1553
DataModelObjectCategory ................................................................................................... 1558
InternalObject ...................................................................................................................... 1559
LinearizedMaximumShearStress .................................................................................................. 1559
DataModelObjectCategory ................................................................................................... 1564
InternalObject ...................................................................................................................... 1564
ShearOrientation .................................................................................................................. 1565
LinearizedMiddlePrincipalStress .................................................................................................. 1565
DataModelObjectCategory ................................................................................................... 1570
InternalObject ...................................................................................................................... 1570
LinearizedMinimumPrincipalStress .............................................................................................. 1571
DataModelObjectCategory ................................................................................................... 1576
InternalObject ...................................................................................................................... 1576
LinearizedNormalStress .............................................................................................................. 1576
DataModelObjectCategory ................................................................................................... 1582
InternalObject ...................................................................................................................... 1582
LinearizedShearStress ................................................................................................................. 1582
DataModelObjectCategory ................................................................................................... 1588
InternalObject ...................................................................................................................... 1588
ShearOrientation .................................................................................................................. 1588
LinearizedStressIntensity ............................................................................................................. 1588
DataModelObjectCategory ................................................................................................... 1594
InternalObject ...................................................................................................................... 1594
LinearizedStressResult ................................................................................................................ 1594
Amplitude ............................................................................................................................ 1598
AverageRadiusOfCurvature ................................................................................................... 1598
BendingInside ...................................................................................................................... 1598
BendingOutside .................................................................................................................... 1599
DataModelObjectCategory ................................................................................................... 1599
Frequency ............................................................................................................................ 1599
InternalObject ...................................................................................................................... 1599
Linearized2DBehavior ........................................................................................................... 1599
LoadMultiplier ...................................................................................................................... 1599
Membrane ............................................................................................................................ 1600
MembraneBendingCenter ..................................................................................................... 1600
MembraneBendingInside ...................................................................................................... 1600
MembraneBendingOutside ................................................................................................... 1600
NormalOrientation ................................................................................................................ 1600
PeakCenter ........................................................................................................................... 1600
PeakInside ............................................................................................................................ 1601
PeakOutside ......................................................................................................................... 1601

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

Position ................................................................................................................................ 1601

StressStrainType ................................................................................................................... 1601
Subtype ................................................................................................................................ 1601
SweepingPhase .................................................................................................................... 1601
ThroughThicknessBendingStress ........................................................................................... 1602
TotalCenter ........................................................................................................................... 1602
TotalInside ............................................................................................................................ 1602
TotalOutside ......................................................................................................................... 1602
ZeroThroughThicknessBendingStress .................................................................................... 1602
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace ....................................... 1603
GasketResult ............................................................................................................................... 1603
DataModelObjectCategory ................................................................................................... 1607
GasketResultType ................................................................................................................. 1607
InternalObject ...................................................................................................................... 1607
NormalGasketPressure ................................................................................................................ 1607
DataModelObjectCategory ................................................................................................... 1611
InternalObject ...................................................................................................................... 1611
NormalGasketTotalClosure .......................................................................................................... 1611
DataModelObjectCategory ................................................................................................... 1614
InternalObject ...................................................................................................................... 1615
ShearGasketPressure ................................................................................................................... 1615
DataModelObjectCategory ................................................................................................... 1618
InternalObject ...................................................................................................................... 1618
ShearOrientation .................................................................................................................. 1619
ShearGasketTotalClosure ............................................................................................................ 1619
DataModelObjectCategory ................................................................................................... 1622
InternalObject ...................................................................................................................... 1623
ShearOrientation .................................................................................................................. 1623
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace ....................................... 1625
ElementalStrainEnergy ................................................................................................................ 1625
DataModelObjectCategory ................................................................................................... 1629
InternalObject ...................................................................................................................... 1629
EnergyResult .............................................................................................................................. 1629
DataModelObjectCategory ................................................................................................... 1632
InternalObject ...................................................................................................................... 1633
StabilizationEnergy ..................................................................................................................... 1633
DataModelObjectCategory ................................................................................................... 1636
InternalObject ...................................................................................................................... 1636
StructuralStrainEnergy ................................................................................................................ 1637
DataModelObjectCategory ................................................................................................... 1640
InternalObject ...................................................................................................................... 1640
Total ..................................................................................................................................... 1640
ThermalStrainEnergy .................................................................................................................. 1641
DataModelObjectCategory ................................................................................................... 1644
InternalObject ...................................................................................................................... 1644
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace ........................ 1645
CurrentDensity ........................................................................................................................... 1645
DataModelObjectCategory ................................................................................................... 1649
InternalObject ...................................................................................................................... 1649
DirectionalMagneticFieldIntensity ............................................................................................... 1649
DataModelObjectCategory ................................................................................................... 1653

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

InternalObject ...................................................................................................................... 1653

NormalOrientation ................................................................................................................ 1653
DirectionalMagneticFluxDensity ................................................................................................. 1653
DataModelObjectCategory ................................................................................................... 1657
InternalObject ...................................................................................................................... 1657
NormalOrientation ................................................................................................................ 1657
ElectricPotential .......................................................................................................................... 1658
DataModelObjectCategory ................................................................................................... 1661
InternalObject ...................................................................................................................... 1661
ElectromagneticResult ................................................................................................................ 1662
AverageAcrossBodies ............................................................................................................ 1665
DataModelObjectCategory ................................................................................................... 1665
ElectromagneticResultType ................................................................................................... 1666
InternalObject ...................................................................................................................... 1666
FluxLinkage ................................................................................................................................ 1666
DataModelObjectCategory ................................................................................................... 1666
InternalObject ...................................................................................................................... 1667
Inductance ................................................................................................................................. 1667
DataModelObjectCategory ................................................................................................... 1667
InternalObject ...................................................................................................................... 1668
MagneticDirectionalForces .......................................................................................................... 1668
DataModelObjectCategory ................................................................................................... 1671
InternalObject ...................................................................................................................... 1672
NormalOrientation ................................................................................................................ 1672
MagneticError ............................................................................................................................. 1672
DataModelObjectCategory ................................................................................................... 1675
InternalObject ...................................................................................................................... 1676
MagneticTotalForces ................................................................................................................... 1676
DataModelObjectCategory ................................................................................................... 1679
InternalObject ...................................................................................................................... 1680
Total ..................................................................................................................................... 1680
TotalMagneticFieldIntensity ........................................................................................................ 1680
DataModelObjectCategory ................................................................................................... 1684
InternalObject ...................................................................................................................... 1684
TotalMagneticFluxDensity ........................................................................................................... 1684
DataModelObjectCategory ................................................................................................... 1688
InternalObject ...................................................................................................................... 1688
Ansys.ACT.Automation.Mechanical.Results.ElectricResults Namespace ....................................... 1689
DirectionalCurrentDensity .......................................................................................................... 1689
DataModelObjectCategory ................................................................................................... 1693
InternalObject ...................................................................................................................... 1693
NormalOrientation ................................................................................................................ 1693
DirectionalElectricFieldIntensity .................................................................................................. 1694
DataModelObjectCategory ................................................................................................... 1698
InternalObject ...................................................................................................................... 1698
NormalOrientation ................................................................................................................ 1698
DirectionalElectricFluxDensity ..................................................................................................... 1698
DataModelObjectCategory ................................................................................................... 1702
InternalObject ...................................................................................................................... 1702
NormalOrientation ................................................................................................................ 1702
ElectricResult .............................................................................................................................. 1702

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

Amplitude ............................................................................................................................ 1706

AverageAcrossBodies ............................................................................................................ 1706
DataModelObjectCategory ................................................................................................... 1706
ElectricResultType ................................................................................................................. 1707
Frequency ............................................................................................................................ 1707
InternalObject ...................................................................................................................... 1707
PhaseIncrement .................................................................................................................... 1707
ReportedFrequency .............................................................................................................. 1707
SweepingPhase .................................................................................................................... 1707
ElectricVoltage ............................................................................................................................ 1708
DataModelObjectCategory ................................................................................................... 1711
InternalObject ...................................................................................................................... 1712
JouleHeat ................................................................................................................................... 1712
DataModelObjectCategory ................................................................................................... 1716
InternalObject ...................................................................................................................... 1716
TotalCurrentDensity .................................................................................................................... 1716
DataModelObjectCategory ................................................................................................... 1720
InternalObject ...................................................................................................................... 1720
TotalElectricFieldIntensity ........................................................................................................... 1720
DataModelObjectCategory ................................................................................................... 1724
InternalObject ...................................................................................................................... 1724
TotalElectricFluxDensity .............................................................................................................. 1725
DataModelObjectCategory ................................................................................................... 1728
InternalObject ...................................................................................................................... 1729
Ansys.ACT.Automation.Mechanical.Results.ContactToolResults Namespace ............................... 1731
ContactFluidPressure .................................................................................................................. 1731
DataModelObjectCategory ................................................................................................... 1735
InternalObject ...................................................................................................................... 1735
ContactFrictionalStress ............................................................................................................... 1735
DataModelObjectCategory ................................................................................................... 1739
InternalObject ...................................................................................................................... 1739
ContactGap ................................................................................................................................ 1739
DataModelObjectCategory ................................................................................................... 1742
InternalObject ...................................................................................................................... 1743
ContactHeatFlux ......................................................................................................................... 1743
DataModelObjectCategory ................................................................................................... 1746
InternalObject ...................................................................................................................... 1746
ContactPenetration ..................................................................................................................... 1747
DataModelObjectCategory ................................................................................................... 1750
InternalObject ...................................................................................................................... 1750
ContactPressure .......................................................................................................................... 1751
DataModelObjectCategory ................................................................................................... 1754
InternalObject ...................................................................................................................... 1754
ContactSlidingDistance ............................................................................................................... 1754
DataModelObjectCategory ................................................................................................... 1758
InternalObject ...................................................................................................................... 1758
ContactStatus ............................................................................................................................. 1758
DataModelObjectCategory ................................................................................................... 1762
InternalObject ...................................................................................................................... 1762
ContactToolResult ....................................................................................................................... 1762
ContactResultType ................................................................................................................ 1766

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

DataModelObjectCategory ................................................................................................... 1766

InternalObject ...................................................................................................................... 1766
Ansys.ACT.Automation.Mechanical.Results.BeamResults Namespace ......................................... 1767
BeamResult ................................................................................................................................ 1767
BeamResultType ................................................................................................................... 1771
DataModelObjectCategory ................................................................................................... 1771
InternalObject ...................................................................................................................... 1771
DirectionalAxialForce .................................................................................................................. 1771
DataModelObjectCategory ................................................................................................... 1775
InternalObject ...................................................................................................................... 1775
DirectionalBendingMoment ........................................................................................................ 1775
DataModelObjectCategory ................................................................................................... 1779
InternalObject ...................................................................................................................... 1779
NormalOrientation ................................................................................................................ 1779
DirectionalShearForce ................................................................................................................. 1779
DataModelObjectCategory ................................................................................................... 1783
InternalObject ...................................................................................................................... 1783
DirectionalShearMomentDiagram ............................................................................................... 1783
DataModelObjectCategory ................................................................................................... 1787
GraphicsDisplay .................................................................................................................... 1787
InternalObject ...................................................................................................................... 1787
ShearMomentType ............................................................................................................... 1787
DirectionalTorsionalMoment ....................................................................................................... 1787
DataModelObjectCategory ................................................................................................... 1791
InternalObject ...................................................................................................................... 1791
TotalAxialForce ........................................................................................................................... 1791
DataModelObjectCategory ................................................................................................... 1795
InternalObject ...................................................................................................................... 1795
TotalBendingMoment ................................................................................................................. 1795
DataModelObjectCategory ................................................................................................... 1798
InternalObject ...................................................................................................................... 1799
TotalShearForce .......................................................................................................................... 1799
DataModelObjectCategory ................................................................................................... 1802
InternalObject ...................................................................................................................... 1802
TotalShearMomentDiagram ........................................................................................................ 1803
DataModelObjectCategory ................................................................................................... 1806
GraphicsDisplay .................................................................................................................... 1806
InternalObject ...................................................................................................................... 1807
ShearMomentType ............................................................................................................... 1807
TotalTorsionalMoment ................................................................................................................ 1807
DataModelObjectCategory ................................................................................................... 1810
InternalObject ...................................................................................................................... 1811
VectorAxialForce ......................................................................................................................... 1811
DataModelObjectCategory ................................................................................................... 1814
InternalObject ...................................................................................................................... 1814
VectorBendingMoment ............................................................................................................... 1815
DataModelObjectCategory ................................................................................................... 1818
InternalObject ...................................................................................................................... 1818
VectorShearForce ........................................................................................................................ 1818
DataModelObjectCategory ................................................................................................... 1822
InternalObject ...................................................................................................................... 1822

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

VectorTorsionalMoment .............................................................................................................. 1822

DataModelObjectCategory ................................................................................................... 1826
InternalObject ...................................................................................................................... 1826
Ansys.ACT.Automation.Mechanical.Results.StressResults Namespace ......................................... 1827
BendingStressEquivalent ............................................................................................................ 1828
DataModelObjectCategory ................................................................................................... 1833
InternalObject ...................................................................................................................... 1834
BendingStressIntensity ............................................................................................................... 1834
DataModelObjectCategory ................................................................................................... 1839
InternalObject ...................................................................................................................... 1840
DirectionalStress ......................................................................................................................... 1840
DataModelObjectCategory ................................................................................................... 1846
InternalObject ...................................................................................................................... 1846
EquivalentStress ......................................................................................................................... 1846
DataModelObjectCategory ................................................................................................... 1852
InternalObject ...................................................................................................................... 1852
EquivalentStressPSD ................................................................................................................... 1852
DataModelObjectCategory ................................................................................................... 1858
InternalObject ...................................................................................................................... 1858
ScaleFactorValue ................................................................................................................... 1858
EquivalentStressRS ...................................................................................................................... 1858
DataModelObjectCategory ................................................................................................... 1864
InternalObject ...................................................................................................................... 1864
MaximumPrincipalStress ............................................................................................................. 1865
DataModelObjectCategory ................................................................................................... 1870
InternalObject ...................................................................................................................... 1870
MaximumShearStress ................................................................................................................. 1871
DataModelObjectCategory ................................................................................................... 1876
InternalObject ...................................................................................................................... 1877
ShearOrientation .................................................................................................................. 1877
MembraneStressEquivalent ......................................................................................................... 1877
DataModelObjectCategory ................................................................................................... 1883
InternalObject ...................................................................................................................... 1883
MembraneStressIntensity ........................................................................................................... 1883
DataModelObjectCategory ................................................................................................... 1889
InternalObject ...................................................................................................................... 1889
MiddlePrincipalStress .................................................................................................................. 1889
DataModelObjectCategory ................................................................................................... 1895
InternalObject ...................................................................................................................... 1895
MinimumPrincipalStress ............................................................................................................. 1895
DataModelObjectCategory ................................................................................................... 1901
InternalObject ...................................................................................................................... 1901
NormalStress .............................................................................................................................. 1902
DataModelObjectCategory ................................................................................................... 1907
InternalObject ...................................................................................................................... 1908
ScaleFactorValue ................................................................................................................... 1908
ShearStress ................................................................................................................................. 1908
DataModelObjectCategory ................................................................................................... 1914
InternalObject ...................................................................................................................... 1914
ScaleFactorValue ................................................................................................................... 1914
ShearOrientation .................................................................................................................. 1914

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

ShellBendingStress ..................................................................................................................... 1914

DataModelObjectCategory ................................................................................................... 1920
InternalObject ...................................................................................................................... 1920
NormalOrientation ................................................................................................................ 1921
ScaleFactorValue ................................................................................................................... 1921
ShellMBPType ....................................................................................................................... 1921
ShellBottomPeakStress ............................................................................................................... 1921
DataModelObjectCategory ................................................................................................... 1927
InternalObject ...................................................................................................................... 1927
NormalOrientation ................................................................................................................ 1927
ShellMBPType ....................................................................................................................... 1928
ShellMembraneStress ................................................................................................................. 1928
DataModelObjectCategory ................................................................................................... 1934
InternalObject ...................................................................................................................... 1934
NormalOrientation ................................................................................................................ 1934
ScaleFactorValue ................................................................................................................... 1934
ShellMBPType ....................................................................................................................... 1934
ShellTopPeakStress ..................................................................................................................... 1934
DataModelObjectCategory ................................................................................................... 1940
InternalObject ...................................................................................................................... 1940
NormalOrientation ................................................................................................................ 1941
ShellMBPType ....................................................................................................................... 1941
StressIntensity ............................................................................................................................ 1941
DataModelObjectCategory ................................................................................................... 1947
InternalObject ...................................................................................................................... 1947
StressResult ................................................................................................................................ 1947
Amplitude ............................................................................................................................ 1951
AverageAcrossBodies ............................................................................................................ 1952
AverageRadiusOfCurvature ................................................................................................... 1952
BendingInside ...................................................................................................................... 1952
BendingOutside .................................................................................................................... 1952
CyclicMode ........................................................................................................................... 1952
DataModelObjectCategory ................................................................................................... 1952
EnvironmentSelection ........................................................................................................... 1953
Frequency ............................................................................................................................ 1953
HarmonicIndex ..................................................................................................................... 1953
InternalObject ...................................................................................................................... 1953
IterationStep ......................................................................................................................... 1953
Layer .................................................................................................................................... 1953
Linearized2DBehavior ........................................................................................................... 1954
LoadMultiplier ...................................................................................................................... 1954
Membrane ............................................................................................................................ 1954
MembraneBendingCenter ..................................................................................................... 1954
MembraneBendingInside ...................................................................................................... 1954
MembraneBendingOutside ................................................................................................... 1954
Mode .................................................................................................................................... 1955
NormalOrientation ................................................................................................................ 1955
PeakCenter ........................................................................................................................... 1955
PeakInside ............................................................................................................................ 1955
PeakOutside ......................................................................................................................... 1955
PhaseIncrement .................................................................................................................... 1955

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

Plies ..................................................................................................................................... 1956

Ply ........................................................................................................................................ 1956
Position ................................................................................................................................ 1956
Probability ............................................................................................................................ 1956
ReportedFrequency .............................................................................................................. 1956
ScaleFactor ........................................................................................................................... 1956
StressStrainType ................................................................................................................... 1957
SubScopeBy ......................................................................................................................... 1957
Subtype ................................................................................................................................ 1957
SweepingPhase .................................................................................................................... 1957
ThroughThicknessBendingStress ........................................................................................... 1957
TotalCenter ........................................................................................................................... 1957
TotalInside ............................................................................................................................ 1958
TotalOutside ......................................................................................................................... 1958
StructuralError ............................................................................................................................ 1958
DataModelObjectCategory ................................................................................................... 1964
InternalObject ...................................................................................................................... 1964
VectorPrincipalStress .................................................................................................................. 1964
DataModelObjectCategory ................................................................................................... 1970
InternalObject ...................................................................................................................... 1970
Ansys.ACT.Automation.Mechanical.Results.FractureToolResults Namespace .............................. 1971
FractureCrackExtensionProbe ..................................................................................................... 1971
DataModelObjectCategory ................................................................................................... 1974
InternalObject ...................................................................................................................... 1974
MaximumValueOverTime ...................................................................................................... 1974
MinimumValueOverTime ...................................................................................................... 1975
ResultProbeValue .................................................................................................................. 1975
FractureEquivalentSIFSRangeProbe ............................................................................................. 1975
DataModelObjectCategory ................................................................................................... 1978
InternalObject ...................................................................................................................... 1978
MaximumValueOverTime ...................................................................................................... 1978
MinimumValueOverTime ...................................................................................................... 1979
ResultProbeValue .................................................................................................................. 1979
FractureJINTProbe ...................................................................................................................... 1979
DataModelObjectCategory ................................................................................................... 1982
InternalObject ...................................................................................................................... 1982
MaximumValueOverTime ...................................................................................................... 1982
MinimumValueOverTime ...................................................................................................... 1982
ResultProbeValue .................................................................................................................. 1983
FractureSIFSProbe ....................................................................................................................... 1983
DataModelObjectCategory ................................................................................................... 1986
FractureProbeSubType .......................................................................................................... 1986
InternalObject ...................................................................................................................... 1986
MaximumValueOverTime ...................................................................................................... 1986
MinimumValueOverTime ...................................................................................................... 1986
ResultProbeValue .................................................................................................................. 1987
FractureTool ............................................................................................................................... 1987
Children ............................................................................................................................... 1988
Comments ............................................................................................................................ 1988
CrackSelection ...................................................................................................................... 1988
CrackSelectionMode ............................................................................................................. 1989

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

DataModelObjectCategory ................................................................................................... 1989

Figures ................................................................................................................................. 1989
Images ................................................................................................................................. 1989
InternalObject ...................................................................................................................... 1989
MultipleCracksSelection ........................................................................................................ 1989
Suppressed ........................................................................................................................... 1990
AddComment() ..................................................................................................................... 1990
AddCrackExtensionProbe() .................................................................................................... 1990
AddCStarIntegral() ................................................................................................................ 1990
AddEquivalentSIFSRange() .................................................................................................... 1990
AddEquivalentSIFSRangeProbe() ........................................................................................... 1990
AddFigure() .......................................................................................................................... 1991
AddImage(string) .................................................................................................................. 1991
AddJINT() .............................................................................................................................. 1991
AddJINTProbe() ..................................................................................................................... 1991
AddMaterialForceX() ............................................................................................................. 1991
AddMaterialForceY() ............................................................................................................. 1992
AddMaterialForceZ() ............................................................................................................. 1992
AddNumberOfCyclesProbe() ................................................................................................. 1992
AddSIFSK1() .......................................................................................................................... 1992
AddSIFSK1Probe() ................................................................................................................. 1992
AddSIFSK2() .......................................................................................................................... 1992
AddSIFSK2Probe() ................................................................................................................. 1993
AddSIFSK3() .......................................................................................................................... 1993
AddSIFSK3Probe() ................................................................................................................. 1993
AddTSTRESS() ....................................................................................................................... 1993
AddVCCTG1() ........................................................................................................................ 1993
AddVCCTG2() ........................................................................................................................ 1993
AddVCCTG3() ........................................................................................................................ 1994
AddVCCTGT() ........................................................................................................................ 1994
Delete() ................................................................................................................................ 1994
EvaluateAllResults() ............................................................................................................... 1994
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1994
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1995
FractureToolProbe ...................................................................................................................... 1995
ActiveContour ...................................................................................................................... 1998
CrackLengthPercentage ........................................................................................................ 1998
DataModelObjectCategory ................................................................................................... 1998
InternalObject ...................................................................................................................... 1999
FractureToolResult ...................................................................................................................... 1999
ActiveContour ...................................................................................................................... 2002
ActiveContourEnd ................................................................................................................ 2003
ActiveContourStart ............................................................................................................... 2003
DataModelObjectCategory ................................................................................................... 2003
FractureResultSubType ......................................................................................................... 2003
FractureResultType ............................................................................................................... 2003
InternalObject ...................................................................................................................... 2003
Mode .................................................................................................................................... 2004
FractureTotalNumberOfCyclesProbe ............................................................................................ 2004
DataModelObjectCategory ................................................................................................... 2007
InternalObject ...................................................................................................................... 2007

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

MaximumValueOverTime ...................................................................................................... 2007

MinimumValueOverTime ...................................................................................................... 2007
ResultProbeValue .................................................................................................................. 2007
Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults Namespace ............................... 2009
FatigueBiaxialityIndication .......................................................................................................... 2009
DataModelObjectCategory ................................................................................................... 2013
InternalObject ...................................................................................................................... 2013
FatigueDamage .......................................................................................................................... 2013
DataModelObjectCategory ................................................................................................... 2017
InternalObject ...................................................................................................................... 2017
FatigueDamageMatrix ................................................................................................................ 2017
DataModelObjectCategory ................................................................................................... 2020
DesignLife ............................................................................................................................ 2021
InternalObject ...................................................................................................................... 2021
MaximumMean .................................................................................................................... 2021
MaximumRange ................................................................................................................... 2021
MinimumMean ..................................................................................................................... 2021
MinimumRange .................................................................................................................... 2021
OutputUnit ........................................................................................................................... 2022
FatigueEquivalentAlternativeStress ............................................................................................. 2022
DataModelObjectCategory ................................................................................................... 2025
InternalObject ...................................................................................................................... 2026
FatigueHysteresis ........................................................................................................................ 2026
DataModelObjectCategory ................................................................................................... 2029
InternalObject ...................................................................................................................... 2029
MaximumStrain .................................................................................................................... 2029
MaximumStress .................................................................................................................... 2029
MinimumStrain ..................................................................................................................... 2030
MinimumStress ..................................................................................................................... 2030
PointsPerSegment ................................................................................................................ 2030
FatigueLife .................................................................................................................................. 2030
DataModelObjectCategory ................................................................................................... 2034
InternalObject ...................................................................................................................... 2034
FatigueRainflowMatrix ................................................................................................................ 2034
DataModelObjectCategory ................................................................................................... 2037
InternalObject ...................................................................................................................... 2037
MaximumMean .................................................................................................................... 2037
MaximumRange ................................................................................................................... 2038
MinimumMean ..................................................................................................................... 2038
MinimumRange .................................................................................................................... 2038
OutputUnit ........................................................................................................................... 2038
FatigueSafetyFactor .................................................................................................................... 2038
DataModelObjectCategory ................................................................................................... 2042
InternalObject ...................................................................................................................... 2042
FatigueSensitivity ....................................................................................................................... 2042
ChartViewingStyle ................................................................................................................ 2043
Children ............................................................................................................................... 2043
Comments ............................................................................................................................ 2043
DataModelObjectCategory ................................................................................................... 2044
DesignLife ............................................................................................................................ 2044
Images ................................................................................................................................. 2044

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

InternalObject ...................................................................................................................... 2044

Location ............................................................................................................................... 2044
LowerVariation ..................................................................................................................... 2044
NumberOfFillPoints .............................................................................................................. 2045
Sensitivity ............................................................................................................................. 2045
Suppressed ........................................................................................................................... 2045
UpperVariation ..................................................................................................................... 2045
AddComment() ..................................................................................................................... 2045
AddImage(string) .................................................................................................................. 2045
Delete() ................................................................................................................................ 2046
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2046
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2046
RenameBasedOnDefinition() ................................................................................................. 2047
FatigueToolResult ....................................................................................................................... 2047
AverageAcrossBodies ............................................................................................................ 2051
DataModelObjectCategory ................................................................................................... 2051
DesignLife ............................................................................................................................ 2051
InternalObject ...................................................................................................................... 2051
Method ................................................................................................................................ 2051
Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace ..................................... 2053
DirectionalHeatFlux .................................................................................................................... 2053
DataModelObjectCategory ................................................................................................... 2057
InternalObject ...................................................................................................................... 2057
Ply ........................................................................................................................................ 2057
DirectionalThermalHeatFlux ........................................................................................................ 2057
DataModelObjectCategory ................................................................................................... 2061
InternalObject ...................................................................................................................... 2061
FluidFlowRate ............................................................................................................................. 2062
DataModelObjectCategory ................................................................................................... 2065
InternalObject ...................................................................................................................... 2065
FluidHeatConductionRate ........................................................................................................... 2066
DataModelObjectCategory ................................................................................................... 2069
InternalObject ...................................................................................................................... 2070
FluidHeatTransportRate .............................................................................................................. 2070
DataModelObjectCategory ................................................................................................... 2073
InternalObject ...................................................................................................................... 2074
TemperatureResult ..................................................................................................................... 2074
DataModelObjectCategory ................................................................................................... 2078
InternalObject ...................................................................................................................... 2078
ThermalError .............................................................................................................................. 2078
DataModelObjectCategory ................................................................................................... 2082
InternalObject ...................................................................................................................... 2082
ThermalResult ............................................................................................................................ 2082
AverageAcrossBodies ............................................................................................................ 2086
DataModelObjectCategory ................................................................................................... 2086
InternalObject ...................................................................................................................... 2086
Layer .................................................................................................................................... 2086
NormalOrientation ................................................................................................................ 2086
Position ................................................................................................................................ 2086
ThermalResultType ............................................................................................................... 2087
TotalHeatFlux ............................................................................................................................. 2087

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

DataModelObjectCategory ................................................................................................... 2091

InternalObject ...................................................................................................................... 2091
VectorHeatFlux ........................................................................................................................... 2091
DataModelObjectCategory ................................................................................................... 2094
InternalObject ...................................................................................................................... 2095
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace .................................. 2097
StressRatio .................................................................................................................................. 2097
DataModelObjectCategory ................................................................................................... 2101
InternalObject ...................................................................................................................... 2101
StressSafetyFactor ....................................................................................................................... 2101
DataModelObjectCategory ................................................................................................... 2104
InternalObject ...................................................................................................................... 2105
StressSafetyMargin ..................................................................................................................... 2105
DataModelObjectCategory ................................................................................................... 2108
InternalObject ...................................................................................................................... 2108
StressTool ................................................................................................................................... 2109
Children ............................................................................................................................... 2109
Comments ............................................................................................................................ 2110
CompressiveLimit ................................................................................................................. 2110
CompressiveLimitType .......................................................................................................... 2110
DataModelObjectCategory ................................................................................................... 2110
Figures ................................................................................................................................. 2110
Images ................................................................................................................................. 2110
InternalObject ...................................................................................................................... 2111
LimitFactor ........................................................................................................................... 2111
StressLimit ............................................................................................................................ 2111
StressLimitType .................................................................................................................... 2111
TensileLimit .......................................................................................................................... 2111
TensileLimitType ................................................................................................................... 2111
Theory .................................................................................................................................. 2112
AddComment() ..................................................................................................................... 2112
AddFigure() .......................................................................................................................... 2112
AddImage(string) .................................................................................................................. 2112
AddSafetyFactor() ................................................................................................................. 2112
AddSafetyMargin() ................................................................................................................ 2113
AddStressRatio() ................................................................................................................... 2113
Delete() ................................................................................................................................ 2113
EvaluateAllResults() ............................................................................................................... 2113
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2113
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2114
StressToolResult .......................................................................................................................... 2114
AverageAcrossBodies ............................................................................................................ 2118
DataModelObjectCategory ................................................................................................... 2118
InternalObject ...................................................................................................................... 2118
Ansys.ACT.Automation.Mechanical.Results.ScriptableResults Namespace .................................. 2119
PythonResult .............................................................................................................................. 2119
By ......................................................................................................................................... 2120
Children ............................................................................................................................... 2120
Comments ............................................................................................................................ 2121
DataModelObjectCategory ................................................................................................... 2121
DisplayTime .......................................................................................................................... 2121

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

Figures ................................................................................................................................. 2121

Images ................................................................................................................................. 2121
InternalObject ...................................................................................................................... 2121
Location ............................................................................................................................... 2122
Mode .................................................................................................................................... 2122
AddComment() ..................................................................................................................... 2122
AddFigure() .......................................................................................................................... 2122
AddImage(string) .................................................................................................................. 2122
ClearGeneratedData() ........................................................................................................... 2123
Evaluate() ............................................................................................................................. 2123
EvaluateAllResults() ............................................................................................................... 2123
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 2123
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2124
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2124
ScriptDefinedResultFolder .......................................................................................................... 2124
Children ............................................................................................................................... 2125
Comments ............................................................................................................................ 2125
DataModelObjectCategory ................................................................................................... 2125
Figures ................................................................................................................................. 2126
Images ................................................................................................................................. 2126
InternalObject ...................................................................................................................... 2126
AddComment() ..................................................................................................................... 2126
AddFigure() .......................................................................................................................... 2126
AddImage(string) .................................................................................................................. 2126
AddPythonResult() ................................................................................................................ 2127
EvaluateAllResults() ............................................................................................................... 2127
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2127
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2127
Ansys.ACT.Automation.Mechanical.Results.ResultTrackers Namespace ....................................... 2129
AddedMassTracker ...................................................................................................................... 2131
DataModelObjectCategory ................................................................................................... 2134
InternalObject ...................................................................................................................... 2134
ArtificialEnergyTracker ................................................................................................................ 2135
DataModelObjectCategory ................................................................................................... 2138
InternalObject ...................................................................................................................... 2138
CampbellDiagram ....................................................................................................................... 2138
CriticalSpeed ........................................................................................................................ 2141
DataModelObjectCategory ................................................................................................... 2141
InternalObject ...................................................................................................................... 2142
Ratio ..................................................................................................................................... 2142
RotationalVelocitySelection .................................................................................................. 2142
Sorting ................................................................................................................................. 2142
XAxisLabel ............................................................................................................................ 2142
XAxisMaximum ..................................................................................................................... 2142
XAxisMinimum ..................................................................................................................... 2143
XAxisRange .......................................................................................................................... 2143
YAxisData ............................................................................................................................. 2143
YAxisLabel ............................................................................................................................ 2143
YAxisMaximum ..................................................................................................................... 2143
YAxisMinimum ...................................................................................................................... 2143
YAxisRange ........................................................................................................................... 2144

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

ContactChatteringTracker ........................................................................................................... 2144

ContactRegion ...................................................................................................................... 2147
ContactSide .......................................................................................................................... 2147
DataModelObjectCategory ................................................................................................... 2147
InternalObject ...................................................................................................................... 2147
ContactClosedPenetrationTracker ............................................................................................... 2148
ContactRegion ...................................................................................................................... 2151
DataModelObjectCategory ................................................................................................... 2151
InternalObject ...................................................................................................................... 2151
ContactDepthTracker .................................................................................................................. 2151
ContactRegion ...................................................................................................................... 2154
DataModelObjectCategory ................................................................................................... 2154
InternalObject ...................................................................................................................... 2154
ContactElasticSlipTracker ............................................................................................................ 2155
ContactRegion ...................................................................................................................... 2158
ContactSide .......................................................................................................................... 2158
DataModelObjectCategory ................................................................................................... 2158
InternalObject ...................................................................................................................... 2158
ContactEnergyTracker ................................................................................................................. 2158
ContactRegion ...................................................................................................................... 2161
DataModelObjectCategory ................................................................................................... 2162
InternalObject ...................................................................................................................... 2162
ContactFluidPressureTracker ....................................................................................................... 2162
ContactRegion ...................................................................................................................... 2165
ContactSide .......................................................................................................................... 2165
DataModelObjectCategory ................................................................................................... 2165
InternalObject ...................................................................................................................... 2166
ContactForceTracker ................................................................................................................... 2166
ContactRegion ...................................................................................................................... 2169
ContactSide .......................................................................................................................... 2169
DataModelObjectCategory ................................................................................................... 2169
InternalObject ...................................................................................................................... 2169
ContactFrictionalDissipationEnergyTracker .................................................................................. 2170
ContactRegion ...................................................................................................................... 2173
DataModelObjectCategory ................................................................................................... 2173
InternalObject ...................................................................................................................... 2173
ContactFrictionalStressTracker .................................................................................................... 2173
ContactRegion ...................................................................................................................... 2176
ContactSide .......................................................................................................................... 2176
DataModelObjectCategory ................................................................................................... 2177
InternalObject ...................................................................................................................... 2177
ContactGapTracker ..................................................................................................................... 2177
ContactRegion ...................................................................................................................... 2180
ContactSide .......................................................................................................................... 2180
DataModelObjectCategory ................................................................................................... 2180
InternalObject ...................................................................................................................... 2180
ContactHeatFluxTracker .............................................................................................................. 2181
ContactRegion ...................................................................................................................... 2184
DataModelObjectCategory ................................................................................................... 2184
InternalObject ...................................................................................................................... 2184
ContactingAreaTracker ............................................................................................................... 2184

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

ContactRegion ...................................................................................................................... 2187

ContactSide .......................................................................................................................... 2187
DataModelObjectCategory ................................................................................................... 2188
InternalObject ...................................................................................................................... 2188
ContactMaximumDampingPressureTracker ................................................................................. 2188
ContactRegion ...................................................................................................................... 2191
ContactSide .......................................................................................................................... 2191
DataModelObjectCategory ................................................................................................... 2191
InternalObject ...................................................................................................................... 2192
ContactMaximumGeometricSlidingDistanceTracker .................................................................... 2192
ContactRegion ...................................................................................................................... 2195
ContactSide .......................................................................................................................... 2195
DataModelObjectCategory ................................................................................................... 2195
InternalObject ...................................................................................................................... 2195
ContactMaximumNormalStiffnessTracker .................................................................................... 2196
ContactRegion ...................................................................................................................... 2199
ContactSide .......................................................................................................................... 2199
DataModelObjectCategory ................................................................................................... 2199
InternalObject ...................................................................................................................... 2199
ContactMaximumTangentialStiffnessTracker ............................................................................... 2199
ContactRegion ...................................................................................................................... 2202
ContactSide .......................................................................................................................... 2203
DataModelObjectCategory ................................................................................................... 2203
InternalObject ...................................................................................................................... 2203
ContactMaxTangentialFluidPressureTracker ................................................................................. 2203
ContactRegion ...................................................................................................................... 2206
DataModelObjectCategory ................................................................................................... 2206
InternalObject ...................................................................................................................... 2206
ContactMinimumGeometricSlidingDistanceTracker ..................................................................... 2207
ContactRegion ...................................................................................................................... 2210
ContactSide .......................................................................................................................... 2210
DataModelObjectCategory ................................................................................................... 2210
InternalObject ...................................................................................................................... 2210
ContactMinimumNormalStiffnessTracker .................................................................................... 2210
ContactRegion ...................................................................................................................... 2213
DataModelObjectCategory ................................................................................................... 2214
InternalObject ...................................................................................................................... 2214
ContactMinimumTangentialStiffnessTracker ................................................................................ 2214
ContactRegion ...................................................................................................................... 2217
ContactSide .......................................................................................................................... 2217
DataModelObjectCategory ................................................................................................... 2217
InternalObject ...................................................................................................................... 2218
ContactNumberStickingTracker ................................................................................................... 2218
ContactRegion ...................................................................................................................... 2221
ContactSide .......................................................................................................................... 2221
DataModelObjectCategory ................................................................................................... 2221
InternalObject ...................................................................................................................... 2221
ContactNumberWithLargePenetrationTracker ............................................................................. 2222
ContactRegion ...................................................................................................................... 2225
DataModelObjectCategory ................................................................................................... 2225
InternalObject ...................................................................................................................... 2225

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

ContactNumberWithTooMuchSlidingTracker ............................................................................... 2225

ContactRegion ...................................................................................................................... 2228
DataModelObjectCategory ................................................................................................... 2228
InternalObject ...................................................................................................................... 2228
ContactPairForceConvergenceNormTracker ................................................................................. 2229
ContactRegion ...................................................................................................................... 2232
DataModelObjectCategory ................................................................................................... 2232
InternalObject ...................................................................................................................... 2232
ContactPenetrationTracker .......................................................................................................... 2232
ContactRegion ...................................................................................................................... 2235
ContactSide .......................................................................................................................... 2235
DataModelObjectCategory ................................................................................................... 2236
InternalObject ...................................................................................................................... 2236
ContactPressureTracker ............................................................................................................... 2236
ContactRegion ...................................................................................................................... 2239
ContactSide .......................................................................................................................... 2239
DataModelObjectCategory ................................................................................................... 2239
InternalObject ...................................................................................................................... 2240
ContactResultingPinballTracker ................................................................................................... 2240
ContactRegion ...................................................................................................................... 2243
ContactSide .......................................................................................................................... 2243
DataModelObjectCategory ................................................................................................... 2243
InternalObject ...................................................................................................................... 2243
ContactSlidingDistanceTracker .................................................................................................... 2244
ContactRegion ...................................................................................................................... 2247
ContactSide .......................................................................................................................... 2247
DataModelObjectCategory ................................................................................................... 2247
InternalObject ...................................................................................................................... 2247
ContactSlidingIndicationTracker .................................................................................................. 2247
ContactRegion ...................................................................................................................... 2250
DataModelObjectCategory ................................................................................................... 2251
InternalObject ...................................................................................................................... 2251
ContactStabilizationEnergyTracker .............................................................................................. 2251
ContactRegion ...................................................................................................................... 2254
DataModelObjectCategory ................................................................................................... 2254
InternalObject ...................................................................................................................... 2254
ContactStrainEnergyTracker ........................................................................................................ 2254
ContactRegion ...................................................................................................................... 2257
DataModelObjectCategory ................................................................................................... 2258
InternalObject ...................................................................................................................... 2258
ContactTangentialDampingStressTracker .................................................................................... 2258
ContactRegion ...................................................................................................................... 2261
DataModelObjectCategory ................................................................................................... 2261
InternalObject ...................................................................................................................... 2261
ContactTotalForceFromContactPressureXTracker ......................................................................... 2262
ContactRegion ...................................................................................................................... 2265
DataModelObjectCategory ................................................................................................... 2265
InternalObject ...................................................................................................................... 2265
ContactTotalForceFromContactPressureYTracker ......................................................................... 2265
ContactRegion ...................................................................................................................... 2268
DataModelObjectCategory ................................................................................................... 2268

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

InternalObject ...................................................................................................................... 2268

ContactTotalForceFromContactPressureZTracker ......................................................................... 2269
ContactRegion ...................................................................................................................... 2272
DataModelObjectCategory ................................................................................................... 2272
InternalObject ...................................................................................................................... 2272
ContactTotalForceFromTangentialStressXTracker ......................................................................... 2272
ContactRegion ...................................................................................................................... 2275
DataModelObjectCategory ................................................................................................... 2275
InternalObject ...................................................................................................................... 2276
ContactTotalForceFromTangentialStressYTracker ......................................................................... 2276
ContactRegion ...................................................................................................................... 2279
DataModelObjectCategory ................................................................................................... 2279
InternalObject ...................................................................................................................... 2279
ContactTotalForceFromTangentialStressZTracker ......................................................................... 2279
ContactRegion ...................................................................................................................... 2282
DataModelObjectCategory ................................................................................................... 2283
InternalObject ...................................................................................................................... 2283
ContactVolumeLossDueToWearTracker ....................................................................................... 2283
ContactRegion ...................................................................................................................... 2286
DataModelObjectCategory ................................................................................................... 2286
InternalObject ...................................................................................................................... 2286
DampingEnergyTracker .............................................................................................................. 2287
DataModelObjectCategory ................................................................................................... 2290
InternalObject ...................................................................................................................... 2290
DensityTracker ............................................................................................................................ 2290
DataModelObjectCategory ................................................................................................... 2293
InternalObject ...................................................................................................................... 2293
LocationCoordinateSystem ................................................................................................... 2293
LocationMethod ................................................................................................................... 2294
LocationXCoordinate ............................................................................................................ 2294
LocationYCoordinate ............................................................................................................ 2294
LocationZCoordinate ............................................................................................................ 2294
DirectionalAccelerationTracker .................................................................................................... 2294
DataModelObjectCategory ................................................................................................... 2297
InternalObject ...................................................................................................................... 2298
LocationCoordinateSystem ................................................................................................... 2298
LocationMethod ................................................................................................................... 2298
LocationXCoordinate ............................................................................................................ 2298
LocationYCoordinate ............................................................................................................ 2298
LocationZCoordinate ............................................................................................................ 2298
DirectionalDeformationTracker ................................................................................................... 2299
DataModelObjectCategory ................................................................................................... 2302
InternalObject ...................................................................................................................... 2302
LocationCoordinateSystem ................................................................................................... 2302
LocationMethod ................................................................................................................... 2302
LocationXCoordinate ............................................................................................................ 2302
LocationYCoordinate ............................................................................................................ 2303
LocationZCoordinate ............................................................................................................ 2303
DirectionalVelocityTracker ........................................................................................................... 2303
DataModelObjectCategory ................................................................................................... 2306
InternalObject ...................................................................................................................... 2306

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

LocationCoordinateSystem ................................................................................................... 2306

LocationMethod ................................................................................................................... 2307
LocationXCoordinate ............................................................................................................ 2307
LocationYCoordinate ............................................................................................................ 2307
LocationZCoordinate ............................................................................................................ 2307
EffectiveStrainTracker ................................................................................................................. 2307
DataModelObjectCategory ................................................................................................... 2310
InternalObject ...................................................................................................................... 2311
LocationCoordinateSystem ................................................................................................... 2311
LocationMethod ................................................................................................................... 2311
LocationXCoordinate ............................................................................................................ 2311
LocationYCoordinate ............................................................................................................ 2311
LocationZCoordinate ............................................................................................................ 2311
EffectiveStressTracker ................................................................................................................. 2312
DataModelObjectCategory ................................................................................................... 2315
InternalObject ...................................................................................................................... 2315
LocationCoordinateSystem ................................................................................................... 2315
LocationMethod ................................................................................................................... 2315
LocationXCoordinate ............................................................................................................ 2315
LocationYCoordinate ............................................................................................................ 2316
LocationZCoordinate ............................................................................................................ 2316
ErodedInternalEnergyTracker ...................................................................................................... 2316
DataModelObjectCategory ................................................................................................... 2319
InternalObject ...................................................................................................................... 2319
ErodedKineticEnergyTracker ....................................................................................................... 2319
DataModelObjectCategory ................................................................................................... 2322
InternalObject ...................................................................................................................... 2322
ExternalForceTracker ................................................................................................................... 2323
DataModelObjectCategory ................................................................................................... 2326
InternalObject ...................................................................................................................... 2326
ForceReactionTracker .................................................................................................................. 2326
DataModelObjectCategory ................................................................................................... 2329
ForceComponentMethod ...................................................................................................... 2329
InternalObject ...................................................................................................................... 2330
LocationCoordinateSystem ................................................................................................... 2330
LocationMethod ................................................................................................................... 2330
LocationXCoordinate ............................................................................................................ 2330
LocationYCoordinate ............................................................................................................ 2330
LocationZCoordinate ............................................................................................................ 2330
HourglassEnergyTracker .............................................................................................................. 2331
ContactRegion ...................................................................................................................... 2334
DataModelObjectCategory ................................................................................................... 2334
InternalObject ...................................................................................................................... 2334
InternalEnergyTracker ................................................................................................................. 2334
DataModelObjectCategory ................................................................................................... 2337
InternalObject ...................................................................................................................... 2337
LocationCoordinateSystem ................................................................................................... 2338
LocationMethod ................................................................................................................... 2338
LocationXCoordinate ............................................................................................................ 2338
LocationYCoordinate ............................................................................................................ 2338
LocationZCoordinate ............................................................................................................ 2338

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

KineticEnergyTracker .................................................................................................................. 2338

DataModelObjectCategory ................................................................................................... 2341
InternalObject ...................................................................................................................... 2342
MomentReactionTracker ............................................................................................................. 2342
DataModelObjectCategory ................................................................................................... 2345
InternalObject ...................................................................................................................... 2345
MomentumTracker ..................................................................................................................... 2345
DataModelObjectCategory ................................................................................................... 2348
InternalObject ...................................................................................................................... 2348
NonLinearStabilizationEnergyTracker .......................................................................................... 2349
DataModelObjectCategory ................................................................................................... 2352
InternalObject ...................................................................................................................... 2352
NumberContactingTracker .......................................................................................................... 2352
ContactRegion ...................................................................................................................... 2355
ContactSide .......................................................................................................................... 2355
DataModelObjectCategory ................................................................................................... 2355
InternalObject ...................................................................................................................... 2355
PlasticWorkTracker ...................................................................................................................... 2356
DataModelObjectCategory ................................................................................................... 2359
InternalObject ...................................................................................................................... 2359
PositionTracker ........................................................................................................................... 2359
DataModelObjectCategory ................................................................................................... 2362
InternalObject ...................................................................................................................... 2362
LocationCoordinateSystem ................................................................................................... 2362
LocationMethod ................................................................................................................... 2363
LocationXCoordinate ............................................................................................................ 2363
LocationYCoordinate ............................................................................................................ 2363
LocationZCoordinate ............................................................................................................ 2363
PressureTracker ........................................................................................................................... 2363
DataModelObjectCategory ................................................................................................... 2366
InternalObject ...................................................................................................................... 2367
LocationCoordinateSystem ................................................................................................... 2367
LocationMethod ................................................................................................................... 2367
LocationXCoordinate ............................................................................................................ 2367
LocationYCoordinate ............................................................................................................ 2367
LocationZCoordinate ............................................................................................................ 2367
RigidBodyVelocityTracker ............................................................................................................ 2368
DataModelObjectCategory ................................................................................................... 2371
InternalObject ...................................................................................................................... 2371
SpringDampingForceTracker ....................................................................................................... 2371
DataModelObjectCategory ................................................................................................... 2374
InternalObject ...................................................................................................................... 2374
SpringElasticForceTracker ........................................................................................................... 2374
DataModelObjectCategory ................................................................................................... 2377
InternalObject ...................................................................................................................... 2378
SpringElongationTracker ............................................................................................................. 2378
DataModelObjectCategory ................................................................................................... 2381
InternalObject ...................................................................................................................... 2381
SpringVelocityTracker ................................................................................................................. 2381
DataModelObjectCategory ................................................................................................... 2384
InternalObject ...................................................................................................................... 2384

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

StiffnessEnergyTracker ................................................................................................................ 2385

DataModelObjectCategory ................................................................................................... 2388
InternalObject ...................................................................................................................... 2388
TemperatureTracker .................................................................................................................... 2388
DataModelObjectCategory ................................................................................................... 2391
InternalObject ...................................................................................................................... 2391
LocationCoordinateSystem ................................................................................................... 2391
LocationMethod ................................................................................................................... 2392
LocationXCoordinate ............................................................................................................ 2392
LocationYCoordinate ............................................................................................................ 2392
LocationZCoordinate ............................................................................................................ 2392
ScopingMethod .................................................................................................................... 2392
TotalEnergyTracker ..................................................................................................................... 2392
DataModelObjectCategory ................................................................................................... 2395
InternalObject ...................................................................................................................... 2396
TotalMassAverageVelocityTracker ................................................................................................ 2396
DataModelObjectCategory ................................................................................................... 2399
InternalObject ...................................................................................................................... 2399
Ansys.ACT.Automation.Mechanical.Results.ProbeResults Namespace ......................................... 2401
AccelerationProbe ...................................................................................................................... 2402
DataModelObjectCategory ................................................................................................... 2405
InternalObject ...................................................................................................................... 2405
AngularAccelerationProbe .......................................................................................................... 2405
DataModelObjectCategory ................................................................................................... 2408
InternalObject ...................................................................................................................... 2408
AngularVelocityProbe ................................................................................................................. 2408
DataModelObjectCategory ................................................................................................... 2411
InternalObject ...................................................................................................................... 2411
BeamProbe ................................................................................................................................. 2412
AxialForce ............................................................................................................................. 2415
DataModelObjectCategory ................................................................................................... 2415
InternalObject ...................................................................................................................... 2415
MaximumAxialForce ............................................................................................................. 2415
MaximumMomentAtI ............................................................................................................ 2416
MaximumMomentAtJ ........................................................................................................... 2416
MaximumShearForceAtI ........................................................................................................ 2416
MaximumShearForceAtJ ....................................................................................................... 2416
MaximumTorque .................................................................................................................. 2416
MinimumAxialForce .............................................................................................................. 2416
MinimumMomentAtI ............................................................................................................ 2417
MinimumMomentAtJ ............................................................................................................ 2417
MinimumShearForceAtI ........................................................................................................ 2417
MinimumShearForceAtJ ........................................................................................................ 2417
MinimumTorque ................................................................................................................... 2417
MomentAtI ........................................................................................................................... 2417
MomentAtJ ........................................................................................................................... 2418
ShearForceAtI ....................................................................................................................... 2418
ShearForceAtJ ....................................................................................................................... 2418
Torque .................................................................................................................................. 2418
BearingProbe .............................................................................................................................. 2418
By ......................................................................................................................................... 2422

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

DampingForce1 .................................................................................................................... 2422

DampingForce2 .................................................................................................................... 2422
DataModelObjectCategory ................................................................................................... 2423
ElasticForce1 ......................................................................................................................... 2423
ElasticForce2 ......................................................................................................................... 2423
Elongation1 .......................................................................................................................... 2423
Elongation2 .......................................................................................................................... 2423
InternalObject ...................................................................................................................... 2423
MaximumDampingForce1 .................................................................................................... 2424
MaximumDampingForce2 .................................................................................................... 2424
MaximumElasticForce1 ......................................................................................................... 2424
MaximumElasticForce2 ......................................................................................................... 2424
MaximumElongation1 .......................................................................................................... 2424
MaximumElongation2 .......................................................................................................... 2424
MaximumVelocity1 ............................................................................................................... 2425
MaximumVelocity2 ............................................................................................................... 2425
MinimumDampingForce1 ..................................................................................................... 2425
MinimumDampingForce2 ..................................................................................................... 2425
MinimumElasticForce1 .......................................................................................................... 2425
MinimumElasticForce2 .......................................................................................................... 2425
MinimumElongation1 ........................................................................................................... 2426
MinimumElongation2 ........................................................................................................... 2426
MinimumVelocity1 ................................................................................................................ 2426
MinimumVelocity2 ................................................................................................................ 2426
PhaseIncrement .................................................................................................................... 2426
ReportedFrequency .............................................................................................................. 2426
ScaleFactor ........................................................................................................................... 2427
ScaleFactorValue ................................................................................................................... 2427
SweepingPhase .................................................................................................................... 2427
Velocity1 .............................................................................................................................. 2427
Velocity2 .............................................................................................................................. 2427
BoltPretensionProbe ................................................................................................................... 2427
Adjustment .......................................................................................................................... 2431
DataModelObjectCategory ................................................................................................... 2431
InternalObject ...................................................................................................................... 2431
MaximumAdjustment ........................................................................................................... 2431
MaximumWorkingLoad ......................................................................................................... 2431
MinimumAdjustment ............................................................................................................ 2431
MinimumWorkingLoad ......................................................................................................... 2432
ScaleFactor ........................................................................................................................... 2432
ScaleFactorValue ................................................................................................................... 2432
WorkingLoad ........................................................................................................................ 2432
ChargeReactionProbe ................................................................................................................. 2432
By ......................................................................................................................................... 2435
ChargeReactionImag ............................................................................................................ 2436
ChargeReactionReal .............................................................................................................. 2436
DataModelObjectCategory ................................................................................................... 2436
Frequency ............................................................................................................................ 2436
InternalObject ...................................................................................................................... 2436
MaximumImagChargeReaction ............................................................................................. 2436
MaximumRealChargeReaction .............................................................................................. 2437

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

MinimumImagChargeReaction ............................................................................................. 2437

MinimumRealChargeReaction ............................................................................................... 2437
ReportedFrequency .............................................................................................................. 2437
SetNumber ........................................................................................................................... 2437
SweepingPhase .................................................................................................................... 2437
CurrentDensityProbe .................................................................................................................. 2438
CurrentDensityTotal .............................................................................................................. 2440
DataModelObjectCategory ................................................................................................... 2441
InternalObject ...................................................................................................................... 2441
XAxisCurrentDensity ............................................................................................................. 2441
YAxisCurrentDensity ............................................................................................................. 2441
ZAxisCurrentDensity ............................................................................................................. 2441
DeformationProbe ...................................................................................................................... 2441
DataModelObjectCategory ................................................................................................... 2445
InternalObject ...................................................................................................................... 2445
MaximumTotalDeformation .................................................................................................. 2445
MaximumXAxisDeformation ................................................................................................. 2445
MaximumYAxisDeformation .................................................................................................. 2445
MaximumZAxisDeformation ................................................................................................. 2446
MinimumTotalDeformation ................................................................................................... 2446
MinimumXAxisDeformation .................................................................................................. 2446
MinimumYAxisDeformation .................................................................................................. 2446
MinimumZAxisDeformation .................................................................................................. 2446
TotalDeformation ................................................................................................................. 2446
XAxisDeformation ................................................................................................................. 2447
XCoordinate ......................................................................................................................... 2447
YAxisDeformation ................................................................................................................. 2447
YCoordinate .......................................................................................................................... 2447
ZAxisDeformation ................................................................................................................. 2447
ZCoordinate ......................................................................................................................... 2447
ElectricFieldProbe ....................................................................................................................... 2448
DataModelObjectCategory ................................................................................................... 2450
InternalObject ...................................................................................................................... 2451
Total ..................................................................................................................................... 2451
YAxisFieldIntensity ................................................................................................................ 2451
ZAxisFieldIntensity ................................................................................................................ 2451
ElectricVoltageProbe ................................................................................................................... 2451
DataModelObjectCategory ................................................................................................... 2454
InternalObject ...................................................................................................................... 2454
MaximumVoltageProbe ........................................................................................................ 2454
MinimumVoltageProbe ......................................................................................................... 2455
VoltageProbe ........................................................................................................................ 2455
ElectromechanicalCouplingCoefficient ........................................................................................ 2455
By ......................................................................................................................................... 2458
DataModelObjectCategory ................................................................................................... 2458
ElectromechanicalCouplingCoefficientValue ......................................................................... 2458
Frequency ............................................................................................................................ 2459
InternalObject ...................................................................................................................... 2459
MaximumElectromechanicalCouplingCoefficient .................................................................. 2459
MinimumElectromechanicalCouplingCoefficient ................................................................... 2459
ReportedFrequency .............................................................................................................. 2459

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

SetNumber ........................................................................................................................... 2459

SweepingPhase .................................................................................................................... 2460
EmagReactionProbe ................................................................................................................... 2460
Current ................................................................................................................................. 2463
DataModelObjectCategory ................................................................................................... 2463
InternalObject ...................................................................................................................... 2463
MaximumCurrent ................................................................................................................. 2463
MinimumCurrent .................................................................................................................. 2463
EnergyProbe ............................................................................................................................... 2464
By ......................................................................................................................................... 2467
ContactEnergy ...................................................................................................................... 2468
DampingEnergy .................................................................................................................... 2468
DataModelObjectCategory ................................................................................................... 2468
ExternalEnergy ..................................................................................................................... 2468
Frequency ............................................................................................................................ 2468
HourglassEnergy ................................................................................................................... 2468
InternalEnergy ...................................................................................................................... 2469
InternalObject ...................................................................................................................... 2469
KineticEnergy ....................................................................................................................... 2469
MagnetostaticCoEnergy ........................................................................................................ 2469
MaximumContactEnergy ...................................................................................................... 2469
MaximumDampingEnergy .................................................................................................... 2469
MaximumExternalEnergy ...................................................................................................... 2470
MaximumHourglassEnergy ................................................................................................... 2470
MaximumInternalEnergy ....................................................................................................... 2470
MaximumKineticEnergy ........................................................................................................ 2470
MaximumPlasticWork ........................................................................................................... 2470
MaximumPotentialEnergy ..................................................................................................... 2470
MaximumStrainEnergy .......................................................................................................... 2471
MaximumTotalEnergy ........................................................................................................... 2471
MaxMagnetostaticCoEnergyOverTime .................................................................................. 2471
MinimumContactEnergy ....................................................................................................... 2471
MinimumDampingEnergy ..................................................................................................... 2471
MinimumExternalEnergy ...................................................................................................... 2471
MinimumHourglassEnergy .................................................................................................... 2472
MinimumInternalEnergy ....................................................................................................... 2472
MinimumKineticEnergy ........................................................................................................ 2472
MinimumPlasticWork ............................................................................................................ 2472
MinimumPotentialEnergy ..................................................................................................... 2472
MinimumStrainEnergy .......................................................................................................... 2472
MinimumTotalEnergy ........................................................................................................... 2473
MinMagnetostaticCoEnergyOverTime ................................................................................... 2473
PlasticWork ........................................................................................................................... 2473
PotentialEnergy .................................................................................................................... 2473
ReportedFrequency .............................................................................................................. 2473
SetNumber ........................................................................................................................... 2473
StrainEnergy ......................................................................................................................... 2474
TotalEnergy .......................................................................................................................... 2474
FieldIntensityProbe ..................................................................................................................... 2474
DataModelObjectCategory ................................................................................................... 2477
InternalObject ...................................................................................................................... 2477

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

TotalFieldIntensity ................................................................................................................ 2477

YAxisFieldIntensity ................................................................................................................ 2477
FlexibleRotationProbe ................................................................................................................. 2477
DataModelObjectCategory ................................................................................................... 2481
InternalObject ...................................................................................................................... 2481
MaximumXAxisRotation ........................................................................................................ 2481
MaximumYAxisRotation ........................................................................................................ 2481
MaximumZAxisRotation ........................................................................................................ 2481
MinimumXAxisRotation ........................................................................................................ 2481
MinimumYAxisRotation ......................................................................................................... 2482
MinimumZAxisRotation ........................................................................................................ 2482
XAxisRotation ....................................................................................................................... 2482
YAxisRotation ....................................................................................................................... 2482
ZAxisRotation ....................................................................................................................... 2482
FluxDensityProbe ....................................................................................................................... 2482
DataModelObjectCategory ................................................................................................... 2485
InternalObject ...................................................................................................................... 2486
Probability ............................................................................................................................ 2486
TotalFluxDensity ................................................................................................................... 2486
XAxisFluxDensity .................................................................................................................. 2486
XCoordinate ......................................................................................................................... 2486
YAxisFluxDensity ................................................................................................................... 2486
YCoordinate .......................................................................................................................... 2487
ZAxisFluxDensity .................................................................................................................. 2487
ZCoordinate ......................................................................................................................... 2487
ForceReaction ............................................................................................................................. 2487
Beam .................................................................................................................................... 2490
By ......................................................................................................................................... 2491
ContactForce ........................................................................................................................ 2491
DataModelObjectCategory ................................................................................................... 2491
Extraction ............................................................................................................................. 2491
Frequency ............................................................................................................................ 2491
InternalObject ...................................................................................................................... 2491
Mode .................................................................................................................................... 2492
PhaseIncrement .................................................................................................................... 2492
Probability ............................................................................................................................ 2492
Reference ............................................................................................................................. 2492
RemotePoints ....................................................................................................................... 2492
ReportedFrequency .............................................................................................................. 2492
ScaleFactor ........................................................................................................................... 2493
ScaleFactorValue ................................................................................................................... 2493
Spring .................................................................................................................................. 2493
SurfaceArea .......................................................................................................................... 2493
SweepingPhase .................................................................................................................... 2493
SymmetryMultiplier .............................................................................................................. 2493
ForceSummationProbe ............................................................................................................... 2494
DataModelObjectCategory ................................................................................................... 2496
InternalObject ...................................................................................................................... 2497
SymmetryMultiplier .............................................................................................................. 2497
GeneralizedPlaneStrainProbe ...................................................................................................... 2497
DataModelObjectCategory ................................................................................................... 2500

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

InternalObject ...................................................................................................................... 2500

HeatFluxProbe ............................................................................................................................ 2500
DataModelObjectCategory ................................................................................................... 2503
InternalObject ...................................................................................................................... 2503
MaximumTotalHeatFlux ........................................................................................................ 2504
MaximumXAxisHeatFlux ....................................................................................................... 2504
MaximumYAxisHeatFlux ........................................................................................................ 2504
MaximumZAxisHeatFlux ....................................................................................................... 2504
MinimumTotalHeatFlux ......................................................................................................... 2504
MinimumXAxisHeatFlux ........................................................................................................ 2504
MinimumYAxisHeatFlux ........................................................................................................ 2505
MinimumZAxisHeatFlux ........................................................................................................ 2505
TotalHeatFlux ....................................................................................................................... 2505
XAxisHeatFlux ....................................................................................................................... 2505
XCoordinate ......................................................................................................................... 2505
YAxisHeatFlux ....................................................................................................................... 2505
YCoordinate .......................................................................................................................... 2506
ZAxisHeatFlux ....................................................................................................................... 2506
ZCoordinate ......................................................................................................................... 2506
ImpedanceProbe ........................................................................................................................ 2506
By ......................................................................................................................................... 2509
DataModelObjectCategory ................................................................................................... 2509
Frequency ............................................................................................................................ 2510
ImpedanceImag ................................................................................................................... 2510
ImpedanceReal ..................................................................................................................... 2510
InternalObject ...................................................................................................................... 2510
MaximumImagImpedance .................................................................................................... 2510
MaximumRealImpedance ..................................................................................................... 2510
MinimumImagImpedance ..................................................................................................... 2511
MinimumRealImpedance ...................................................................................................... 2511
ReportedFrequency .............................................................................................................. 2511
SetNumber ........................................................................................................................... 2511
SweepingPhase .................................................................................................................... 2511
JointProbe .................................................................................................................................. 2511
DataModelObjectCategory ................................................................................................... 2514
InternalObject ...................................................................................................................... 2515
OrientationMethod ............................................................................................................... 2515
ResultType ............................................................................................................................ 2515
Status ................................................................................................................................... 2515
JouleHeatProbe .......................................................................................................................... 2515
By ......................................................................................................................................... 2518
DataModelObjectCategory ................................................................................................... 2518
Frequency ............................................................................................................................ 2519
InternalObject ...................................................................................................................... 2519
JouleHeat ............................................................................................................................. 2519
MaximumJouleHeat .............................................................................................................. 2519
MinimumJouleHeat .............................................................................................................. 2519
ReportedFrequency .............................................................................................................. 2519
SetNumber ........................................................................................................................... 2520
SweepingPhase .................................................................................................................... 2520
MagneticFluxProbe ..................................................................................................................... 2520

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

DataModelObjectCategory ................................................................................................... 2523

InternalObject ...................................................................................................................... 2523
MagneticFlux ........................................................................................................................ 2523
MaximumMagneticFlux ........................................................................................................ 2523
MinimumMagneticFlux ......................................................................................................... 2524
SymmetryMultiplier .............................................................................................................. 2524
MomentReaction ........................................................................................................................ 2524
Beam .................................................................................................................................... 2527
By ......................................................................................................................................... 2527
ContactForce ........................................................................................................................ 2527
DataModelObjectCategory ................................................................................................... 2528
Extraction ............................................................................................................................. 2528
Frequency ............................................................................................................................ 2528
InternalObject ...................................................................................................................... 2528
Mode .................................................................................................................................... 2528
PhaseIncrement .................................................................................................................... 2528
Probability ............................................................................................................................ 2529
Reference ............................................................................................................................. 2529
RemotePoints ....................................................................................................................... 2529
ReportedFrequency .............................................................................................................. 2529
ScaleFactor ........................................................................................................................... 2529
ScaleFactorValue ................................................................................................................... 2529
SurfaceArea .......................................................................................................................... 2530
SweepingPhase .................................................................................................................... 2530
SymmetryMultiplier .............................................................................................................. 2530
Position ...................................................................................................................................... 2530
DataModelObjectCategory ................................................................................................... 2533
InternalObject ...................................................................................................................... 2533
QualityFactor .............................................................................................................................. 2533
By ......................................................................................................................................... 2536
DataModelObjectCategory ................................................................................................... 2536
Frequency ............................................................................................................................ 2537
InternalObject ...................................................................................................................... 2537
MaximumQualityFactor ......................................................................................................... 2537
MinimumQualityFactor ......................................................................................................... 2537
QualityFactorValue ................................................................................................................ 2537
ReportedFrequency .............................................................................................................. 2537
SetNumber ........................................................................................................................... 2538
SweepingPhase .................................................................................................................... 2538
RadiationProbe ........................................................................................................................... 2538
DataModelObjectCategory ................................................................................................... 2541
EmittedRadiation .................................................................................................................. 2541
IncidentRadiation ................................................................................................................. 2541
InternalObject ...................................................................................................................... 2541
NetRadiation ........................................................................................................................ 2542
ReflectedRadiation ............................................................................................................... 2542
ReactionProbe ............................................................................................................................ 2542
DataModelObjectCategory ................................................................................................... 2545
Extraction ............................................................................................................................. 2545
Heat ..................................................................................................................................... 2545
InternalObject ...................................................................................................................... 2545

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

MaximumHeat ...................................................................................................................... 2545

MinimumHeat ...................................................................................................................... 2546
ResponsePSD .............................................................................................................................. 2546
AccelerationInG .................................................................................................................... 2549
DataModelObjectCategory ................................................................................................... 2549
ExpectedFrequency .............................................................................................................. 2549
InternalObject ...................................................................................................................... 2549
Probability ............................................................................................................................ 2550
RangeMaximum ................................................................................................................... 2550
RangeMinimum .................................................................................................................... 2550
Reference ............................................................................................................................. 2550
ResultType ............................................................................................................................ 2550
RMSPercentage .................................................................................................................... 2550
RMSValue ............................................................................................................................. 2551
SelectedFrequencyRange ..................................................................................................... 2551
ResultProbe ................................................................................................................................ 2551
BeamSelection ...................................................................................................................... 2553
BoundaryConditionSelection ................................................................................................ 2553
Children ............................................................................................................................... 2553
Comments ............................................................................................................................ 2553
ContactRegionSelection ....................................................................................................... 2553
CoordinateSystemSelection .................................................................................................. 2554
DataModelObjectCategory ................................................................................................... 2554
DisplayTime .......................................................................................................................... 2554
DpfEvaluation ....................................................................................................................... 2554
Figures ................................................................................................................................. 2554
GeometryLocation ................................................................................................................ 2554
Images ................................................................................................................................. 2555
InternalObject ...................................................................................................................... 2555
IsSolved ................................................................................................................................ 2555
IterationNumber ................................................................................................................... 2555
LoadStep .............................................................................................................................. 2555
LoadStepNumber ................................................................................................................. 2555
LocationMethod ................................................................................................................... 2556
MaximumTotal ...................................................................................................................... 2556
MaximumXAxis ..................................................................................................................... 2556
MaximumYAxis ..................................................................................................................... 2556
MaximumZAxis ..................................................................................................................... 2556
MeshConnectionSelection .................................................................................................... 2556
MinimumTotal ...................................................................................................................... 2557
MinimumXAxis ..................................................................................................................... 2557
MinimumYAxis ...................................................................................................................... 2557
MinimumZAxis ..................................................................................................................... 2557
Orientation ........................................................................................................................... 2557
RemotePointSelection .......................................................................................................... 2557
ResultSelection ..................................................................................................................... 2558
SpatialResolution .................................................................................................................. 2558
SpringSelection .................................................................................................................... 2558
Substep ................................................................................................................................ 2558
Summation ........................................................................................................................... 2558
Suppressed ........................................................................................................................... 2558

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

SurfaceSelection ................................................................................................................... 2559

Time ..................................................................................................................................... 2559
Total ..................................................................................................................................... 2559
Type ..................................................................................................................................... 2559
XAxis .................................................................................................................................... 2559
YAxis ..................................................................................................................................... 2559
ZAxis .................................................................................................................................... 2560
AddComment() ..................................................................................................................... 2560
AddFigure() .......................................................................................................................... 2560
AddImage(string) .................................................................................................................. 2560
ClearGeneratedData() ........................................................................................................... 2560
Delete() ................................................................................................................................ 2561
DuplicateWithoutResults() .................................................................................................... 2561
EvaluateAllResults() ............................................................................................................... 2561
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 2561
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2562
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2562
RenameBasedOnDefinition() ................................................................................................. 2562
SnapToMeshNodes() ............................................................................................................. 2563
RotationProbe ............................................................................................................................ 2563
DataModelObjectCategory ................................................................................................... 2566
InternalObject ...................................................................................................................... 2566
MaximumXAxisRotation ........................................................................................................ 2566
MaximumYAxisRotation ........................................................................................................ 2566
MaximumZAxisRotation ........................................................................................................ 2567
MinimumXAxisRotation ........................................................................................................ 2567
MinimumYAxisRotation ......................................................................................................... 2567
MinimumZAxisRotation ........................................................................................................ 2567
XAxisRotation ....................................................................................................................... 2567
YAxisRotation ....................................................................................................................... 2567
ZAxisRotation ....................................................................................................................... 2568
SpringProbe ............................................................................................................................... 2568
By ......................................................................................................................................... 2571
DampingForce ...................................................................................................................... 2571
DataModelObjectCategory ................................................................................................... 2571
ElasticForce .......................................................................................................................... 2572
Elongation ............................................................................................................................ 2572
Frequency ............................................................................................................................ 2572
InternalObject ...................................................................................................................... 2572
MaximumDampingForce ...................................................................................................... 2572
MaximumElasticForce ........................................................................................................... 2572
MaximumElongation ............................................................................................................ 2573
MaximumVelocity ................................................................................................................. 2573
MinimumDampingForce ....................................................................................................... 2573
MinimumElasticForce ............................................................................................................ 2573
MinimumElongation ............................................................................................................. 2573
MinimumVelocity ................................................................................................................. 2573
ScaleFactor ........................................................................................................................... 2574
ScaleFactorValue ................................................................................................................... 2574
Spring .................................................................................................................................. 2574
SweepingPhase .................................................................................................................... 2574

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

Velocity ................................................................................................................................ 2574

StrainProbe ................................................................................................................................. 2574
DataModelObjectCategory ................................................................................................... 2578
EquivalentStrain ................................................................................................................... 2578
InternalObject ...................................................................................................................... 2578
MaximumEquivalentStrain .................................................................................................... 2579
MaximumMaximumPrincipalStrain ........................................................................................ 2579
MaximumMiddlePrincipalStrain ............................................................................................ 2579
MaximumMinimumPrincipalStrain ........................................................................................ 2579
MaximumNormalXAxisStrain ................................................................................................ 2579
MaximumNormalYAxisStrain ................................................................................................. 2579
MaximumNormalZAxisStrain ................................................................................................. 2580
MaximumPrincipalStrain ....................................................................................................... 2580
MaximumStrainIntensity ....................................................................................................... 2580
MaximumXYShearStrain ....................................................................................................... 2580
MaximumXZShearStrain ....................................................................................................... 2580
MaximumYZShearStrain ........................................................................................................ 2580
MiddlePrincipalStrain ............................................................................................................ 2581
MinimumEquivalentStrain ..................................................................................................... 2581
MinimumMiddlePrincipalStrain ............................................................................................. 2581
MinimumMinimumPrincipalStrain ......................................................................................... 2581
MinimumNormalXAxisStrain ................................................................................................. 2581
MinimumNormalYAxisStrain ................................................................................................. 2581
MinimumNormalZAxisStrain ................................................................................................. 2582
MinimumPrincipalStrain ....................................................................................................... 2582
MinimumStrain ..................................................................................................................... 2582
MinimumStrainIntensity ....................................................................................................... 2582
MinimumStrainMaximumPrincipal ........................................................................................ 2582
MinimumXYShearStrain ........................................................................................................ 2582
MinimumXZShearStrain ........................................................................................................ 2583
MinimumYZShearStrain ........................................................................................................ 2583
NormalXAxisStrain ................................................................................................................ 2583
NormalYAxisStrain ................................................................................................................ 2583
NormalZAxisStrain ................................................................................................................ 2583
Strain .................................................................................................................................... 2583
StrainIntensity ...................................................................................................................... 2584
XYShearStrain ....................................................................................................................... 2584
XZShearStrain ....................................................................................................................... 2584
YZShearStrain ....................................................................................................................... 2584
StressProbe ................................................................................................................................ 2584
DataModelObjectCategory ................................................................................................... 2588
EquivalentStress ................................................................................................................... 2588
InternalObject ...................................................................................................................... 2588
MaximumEquivalentStress .................................................................................................... 2589
MaximumMaximumPrincipalStress ....................................................................................... 2589
MaximumMiddlePrincipalStress ............................................................................................ 2589
MaximumMinimumPrincipalStress ........................................................................................ 2589
MaximumNormalXAxisStress ................................................................................................ 2589
MaximumNormalYAxisStress ................................................................................................. 2589
MaximumNormalZAxisStress ................................................................................................ 2590
MaximumPrincipalStress ....................................................................................................... 2590

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

MaximumStressIntensity ....................................................................................................... 2590

MaximumXYShearStress ....................................................................................................... 2590
MaximumXZShearStress ....................................................................................................... 2590
MaximumYZShearStress ....................................................................................................... 2590
MiddlePrincipalStress ............................................................................................................ 2591
MinimumEquivalentStress .................................................................................................... 2591
MinimumMaximumPrincipalStress ........................................................................................ 2591
MinimumMiddlePrincipalStress ............................................................................................. 2591
MinimumMinimumPrincipalStress ......................................................................................... 2591
MinimumNormalXAxisStress ................................................................................................. 2591
MinimumNormalYAxisStress ................................................................................................. 2592
MinimumNormalZAxisStress ................................................................................................. 2592
MinimumPrincipalStress ....................................................................................................... 2592
MinimumStressIntensity ....................................................................................................... 2592
MinimumXYShearStress ........................................................................................................ 2592
MinimumXZShearStress ........................................................................................................ 2592
MinimumYZShearStress ........................................................................................................ 2593
NormalXAxisStress ................................................................................................................ 2593
NormalYAxisStress ................................................................................................................ 2593
NormalZAxisStress ................................................................................................................ 2593
StressIntensity ...................................................................................................................... 2593
XCoordinate ......................................................................................................................... 2593
XYShearStress ....................................................................................................................... 2594
XZShearStress ....................................................................................................................... 2594
YCoordinate .......................................................................................................................... 2594
YZShearStress ....................................................................................................................... 2594
ZCoordinate ......................................................................................................................... 2594
TemperatureProbe ...................................................................................................................... 2594
DataModelObjectCategory ................................................................................................... 2597
InternalObject ...................................................................................................................... 2598
MaximumTemperature ......................................................................................................... 2598
MinimumTemperature .......................................................................................................... 2598
Temperature ......................................................................................................................... 2598
XCoordinate ......................................................................................................................... 2598
YCoordinate .......................................................................................................................... 2598
ZCoordinate ......................................................................................................................... 2599
TorqueProbe ............................................................................................................................... 2599
DataModelObjectCategory ................................................................................................... 2602
InternalObject ...................................................................................................................... 2602
SymmetryMultiplier .............................................................................................................. 2602
VelocityProbe ............................................................................................................................. 2602
DataModelObjectCategory ................................................................................................... 2605
InternalObject ...................................................................................................................... 2605
VolumeProbe .............................................................................................................................. 2605
DataModelObjectCategory ................................................................................................... 2608
InternalObject ...................................................................................................................... 2608
MaximumVolume ................................................................................................................. 2609
MinimumVolume .................................................................................................................. 2609
VolumeResult ....................................................................................................................... 2609
XCoordinate ......................................................................................................................... 2609
YCoordinate .......................................................................................................................... 2609

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

ZCoordinate ......................................................................................................................... 2609

Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults Namespace .................. 2611
AccelerationFrequencyResponse ................................................................................................. 2612
DataModelObjectCategory ................................................................................................... 2615
InternalObject ...................................................................................................................... 2615
AcousticAWeightedSPLFrequencyResponse ................................................................................ 2615
DataModelObjectCategory ................................................................................................... 2618
InternalObject ...................................................................................................................... 2618
AcousticKineticEnergyFrequencyResponse .................................................................................. 2618
DataModelObjectCategory ................................................................................................... 2621
InternalObject ...................................................................................................................... 2622
AcousticPotentialEnergyFrequencyResponse .............................................................................. 2622
DataModelObjectCategory ................................................................................................... 2625
InternalObject ...................................................................................................................... 2625
AcousticPressureFrequencyResponse .......................................................................................... 2625
DataModelObjectCategory ................................................................................................... 2628
InternalObject ...................................................................................................................... 2628
AcousticSPLFrequencyResponse ................................................................................................. 2629
DataModelObjectCategory ................................................................................................... 2632
InternalObject ...................................................................................................................... 2632
ExportToWAVFile(string) ........................................................................................................ 2632
ExportToXMLFile(string) ........................................................................................................ 2632
AcousticVelocityFrequencyResponse ........................................................................................... 2633
DataModelObjectCategory ................................................................................................... 2636
InternalObject ...................................................................................................................... 2636
ChargeReactionFrequencyResponse ........................................................................................... 2636
DataModelObjectCategory ................................................................................................... 2639
InternalObject ...................................................................................................................... 2639
LocationMethod ................................................................................................................... 2639
DeformationFrequencyResponse ................................................................................................ 2640
ContactRegion ...................................................................................................................... 2643
DataModelObjectCategory ................................................................................................... 2643
InternalObject ...................................................................................................................... 2643
ElasticStrainFrequencyResponse ................................................................................................. 2643
DataModelObjectCategory ................................................................................................... 2646
InternalObject ...................................................................................................................... 2646
EquivalentRadiatedPower ........................................................................................................... 2647
DataModelObjectCategory ................................................................................................... 2650
FrequencyRange ................................................................................................................... 2650
InternalObject ...................................................................................................................... 2651
MaximumFrequency ............................................................................................................. 2651
MinimumFrequency ............................................................................................................. 2651
EquivalentRadiatedPowerLevel ................................................................................................... 2651
DataModelObjectCategory ................................................................................................... 2655
FrequencyRange ................................................................................................................... 2655
InternalObject ...................................................................................................................... 2655
MaximumFrequency ............................................................................................................. 2655
MinimumFrequency ............................................................................................................. 2655
ExportToWAVFile(string) ........................................................................................................ 2655
ExportToXMLFile(string) ........................................................................................................ 2656
EquivalentRadiatedPowerLevelWaterfallDiagram ......................................................................... 2656

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

DataModelObjectCategory ................................................................................................... 2660

InternalObject ...................................................................................................................... 2660
ExportToWAVFile(string) ........................................................................................................ 2660
ExportToXMLFile(string) ........................................................................................................ 2660
EquivalentRadiatedPowerWaterfallDiagram ................................................................................ 2660
DataModelObjectCategory ................................................................................................... 2664
InternalObject ...................................................................................................................... 2664
ForceReactionFrequencyResponse .............................................................................................. 2664
Beam .................................................................................................................................... 2667
ContactRegion ...................................................................................................................... 2668
DataModelObjectCategory ................................................................................................... 2668
InternalObject ...................................................................................................................... 2668
LocationMethod ................................................................................................................... 2668
RemotePoint ......................................................................................................................... 2668
FrequencyResponseResultChart .................................................................................................. 2668
CoordinateSystem ................................................................................................................ 2671
DataModelObjectCategory ................................................................................................... 2672
InternalObject ...................................................................................................................... 2672
RemotePointSelection .......................................................................................................... 2672
ImpedanceFrequencyResponse .................................................................................................. 2672
DataModelObjectCategory ................................................................................................... 2675
InternalObject ...................................................................................................................... 2675
LocationMethod ................................................................................................................... 2676
StressFrequencyResponse ........................................................................................................... 2676
DataModelObjectCategory ................................................................................................... 2679
InternalObject ...................................................................................................................... 2679
VelocityFrequencyResponse ........................................................................................................ 2679
ContactRegion ...................................................................................................................... 2682
DataModelObjectCategory ................................................................................................... 2683
InternalObject ...................................................................................................................... 2683
VoltageFrequencyResponse ........................................................................................................ 2683
DataModelObjectCategory ................................................................................................... 2686
InternalObject ...................................................................................................................... 2686
Ansys.ACT.Automation.Mechanical.Results.CompositeFailureResults Namespace ...................... 2687
CompositeFailureTool ................................................................................................................. 2687
Children ............................................................................................................................... 2688
Comments ............................................................................................................................ 2688
DataModelObjectCategory ................................................................................................... 2688
Figures ................................................................................................................................. 2688
Images ................................................................................................................................. 2688
InternalObject ...................................................................................................................... 2689
AddComment() ..................................................................................................................... 2689
AddFigure() .......................................................................................................................... 2689
AddGroupedScopedACPResults(ResultType, IEnumerable<IDataModelObject>) .................... 2689
AddImage(string) .................................................................................................................. 2690
AddInverseReserveFactor() .................................................................................................... 2690
AddSafetyFactor() ................................................................................................................. 2690
AddSafetyMargin() ................................................................................................................ 2690
Delete() ................................................................................................................................ 2690
EvaluateAllResults() ............................................................................................................... 2691
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2691

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

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2691

CompositeSamplingPoint ........................................................................................................... 2692
Children ............................................................................................................................... 2692
Comments ............................................................................................................................ 2692
DataModelObjectCategory ................................................................................................... 2693
Figures ................................................................................................................................. 2693
Images ................................................................................................................................. 2693
InternalObject ...................................................................................................................... 2693
Location ............................................................................................................................... 2693
AddComment() ..................................................................................................................... 2693
AddFigure() .......................................................................................................................... 2694
AddImage(string) .................................................................................................................. 2694
Delete() ................................................................................................................................ 2694
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2694
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2695
CompositeSamplingPointTool ..................................................................................................... 2695
Children ............................................................................................................................... 2696
Comments ............................................................................................................................ 2696
DataModelObjectCategory ................................................................................................... 2696
Figures ................................................................................................................................. 2696
Images ................................................................................................................................. 2696
InternalObject ...................................................................................................................... 2697
AddComment() ..................................................................................................................... 2697
AddCompositeSamplingPoint() ............................................................................................. 2697
AddFigure() .......................................................................................................................... 2697
AddImage(string) .................................................................................................................. 2697
Delete() ................................................................................................................................ 2698
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2698
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2698
Ansys.ACT.Automation.Mechanical.Results.BoltToolResults Namespace ..................................... 2701
BoltAdjustment .......................................................................................................................... 2701
BoltResultType ...................................................................................................................... 2705
DataModelObjectCategory ................................................................................................... 2705
InternalObject ...................................................................................................................... 2705
BoltTool ...................................................................................................................................... 2705
Children ............................................................................................................................... 2706
Comments ............................................................................................................................ 2706
DataModelObjectCategory ................................................................................................... 2706
Figures ................................................................................................................................. 2706
Images ................................................................................................................................. 2706
InternalObject ...................................................................................................................... 2707
AddAdjustment() .................................................................................................................. 2707
AddComment() ..................................................................................................................... 2707
AddFigure() .......................................................................................................................... 2707
AddImage(string) .................................................................................................................. 2707
AddWorkingLoad() ................................................................................................................ 2708
Delete() ................................................................................................................................ 2708
EvaluateAllResults() ............................................................................................................... 2708
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2708
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2709
BoltToolResult ............................................................................................................................ 2709

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

DataModelObjectCategory ................................................................................................... 2712

InternalObject ...................................................................................................................... 2713
BoltWorkingLoad ........................................................................................................................ 2713
BoltResultType ...................................................................................................................... 2716
DataModelObjectCategory ................................................................................................... 2716
InternalObject ...................................................................................................................... 2717
Ansys.ACT.Automation.Mechanical.Results.BeamToolResults Namespace .................................. 2719
BeamTool ................................................................................................................................... 2719
Children ............................................................................................................................... 2720
Comments ............................................................................................................................ 2720
DataModelObjectCategory ................................................................................................... 2720
Figures ................................................................................................................................. 2721
Images ................................................................................................................................. 2721
InternalObject ...................................................................................................................... 2721
Location ............................................................................................................................... 2721
AddComment() ..................................................................................................................... 2721
AddDirectionalDeformation() ................................................................................................ 2721
AddDirectStress() .................................................................................................................. 2722
AddFigure() .......................................................................................................................... 2722
AddImage(string) .................................................................................................................. 2722
AddMaximumBendingStress() ............................................................................................... 2722
AddMaximumCombinedStress() ............................................................................................ 2722
AddMinimumBendingStress() ............................................................................................... 2723
AddMinimumCombinedStress() ............................................................................................ 2723
AddTotalDeformation() ......................................................................................................... 2723
Delete() ................................................................................................................................ 2723
EvaluateAllResults() ............................................................................................................... 2723
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2723
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2724
BeamToolResult .......................................................................................................................... 2724
BeamToolStressResultType .................................................................................................... 2728
DataModelObjectCategory ................................................................................................... 2728
InternalObject ...................................................................................................................... 2728
DirectStress ................................................................................................................................ 2728
DataModelObjectCategory ................................................................................................... 2732
InternalObject ...................................................................................................................... 2732
MaximumBendingStress ............................................................................................................. 2732
DataModelObjectCategory ................................................................................................... 2736
InternalObject ...................................................................................................................... 2736
MaximumCombinedStress .......................................................................................................... 2736
DataModelObjectCategory ................................................................................................... 2740
InternalObject ...................................................................................................................... 2740
MinimumBendingStress .............................................................................................................. 2740
DataModelObjectCategory ................................................................................................... 2743
InternalObject ...................................................................................................................... 2744
MinimumCombinedStress ........................................................................................................... 2744
DataModelObjectCategory ................................................................................................... 2747
InternalObject ...................................................................................................................... 2747
Ansys.ACT.Automation.Mechanical.Results.AcousticResults Namespace ..................................... 2749
AcousticAbsorptionCoefficient .................................................................................................... 2749
DataModelObjectCategory ................................................................................................... 2754

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

FrequencyRange ................................................................................................................... 2754

InputPort .............................................................................................................................. 2754
InternalObject ...................................................................................................................... 2754
MaximumFrequency ............................................................................................................. 2754
MinimumFrequency ............................................................................................................. 2754
AcousticAWeightedSoundPressureLevel ...................................................................................... 2755
DataModelObjectCategory ................................................................................................... 2759
InternalObject ...................................................................................................................... 2759
AcousticDiffuseSoundTransmissionLoss ...................................................................................... 2759
DataModelObjectCategory ................................................................................................... 2763
FrequencyRange ................................................................................................................... 2763
InternalObject ...................................................................................................................... 2763
MaximumFrequency ............................................................................................................. 2763
MinimumFrequency ............................................................................................................. 2764
AcousticDirectionalVelocityResult ............................................................................................... 2764
DataModelObjectCategory ................................................................................................... 2768
InternalObject ...................................................................................................................... 2768
NormalOrientation ................................................................................................................ 2768
AcousticFarFieldResult ................................................................................................................ 2768
DampedFrequency ............................................................................................................... 2773
DataModelObjectCategory ................................................................................................... 2773
Density ................................................................................................................................. 2773
EndingRadiationAnglePhi ..................................................................................................... 2773
EndingRadiationAngleTheta ................................................................................................. 2774
FarFieldMicrophoneDefinitionMethod .................................................................................. 2774
InternalObject ...................................................................................................................... 2774
LogarithmicDecrement ......................................................................................................... 2774
ModalDampingRatio ............................................................................................................. 2774
ModelThicknessInZDirection ................................................................................................. 2774
ModelType ........................................................................................................................... 2775
PhiAngleEnd ......................................................................................................................... 2775
PhiAngleNoOfDivisions ......................................................................................................... 2775
PhiAngleStart ....................................................................................................................... 2775
ReferenceRMSSoundPressure ................................................................................................ 2775
ReferenceSoundPower .......................................................................................................... 2775
ReportedFrequency .............................................................................................................. 2776
SoundSpeed ......................................................................................................................... 2776
SpatialRadiationAngle .......................................................................................................... 2776
SphereRadius ....................................................................................................................... 2776
Stability ................................................................................................................................ 2776
StartingRadiationAnglePhi .................................................................................................... 2776
StartingRadiationAngleTheta ................................................................................................ 2777
ThetaAngleEnd ..................................................................................................................... 2777
ThetaAngleNoOfDivisions ..................................................................................................... 2777
ThetaAngleStart ................................................................................................................... 2777
Worksheet ............................................................................................................................ 2777
XCoordinate ......................................................................................................................... 2777
YAxisExtrusionAngle ............................................................................................................. 2778
YCoordinate .......................................................................................................................... 2778
ZCoordinate ......................................................................................................................... 2778
ExportToWAVFile(string) ........................................................................................................ 2778

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

ExportToXMLFile(string) ........................................................................................................ 2778

AcousticFarFieldSoundPowerLevelWaterfallDiagram ................................................................... 2779
DataModelObjectCategory ................................................................................................... 2785
InternalObject ...................................................................................................................... 2785
AcousticFarFieldSPLMicWaterfallDiagram .................................................................................... 2785
DataModelObjectCategory ................................................................................................... 2791
InternalObject ...................................................................................................................... 2791
AcousticFrequencyBandAWeightedSPL ....................................................................................... 2791
DataModelObjectCategory ................................................................................................... 2795
InternalObject ...................................................................................................................... 2795
AcousticFrequencyBandSPL ........................................................................................................ 2796
DataModelObjectCategory ................................................................................................... 2800
InternalObject ...................................................................................................................... 2800
AcousticKineticEnergy ................................................................................................................ 2800
DataModelObjectCategory ................................................................................................... 2804
InternalObject ...................................................................................................................... 2804
AcousticPotentialEnergy ............................................................................................................. 2804
DataModelObjectCategory ................................................................................................... 2808
InternalObject ...................................................................................................................... 2808
AcousticPressureResult ............................................................................................................... 2809
DataModelObjectCategory ................................................................................................... 2813
InternalObject ...................................................................................................................... 2813
ExportToWAVFile(string) ........................................................................................................ 2813
AcousticResult ............................................................................................................................ 2813
Amplitude ............................................................................................................................ 2817
DampedFrequency ............................................................................................................... 2817
DataModelObjectCategory ................................................................................................... 2817
Frequency ............................................................................................................................ 2817
InternalObject ...................................................................................................................... 2818
LogarithmicDecrement ......................................................................................................... 2818
ModalDampingRatio ............................................................................................................. 2818
Mode .................................................................................................................................... 2818
ReportedFrequency .............................................................................................................. 2818
Stability ................................................................................................................................ 2818
SweepingPhase .................................................................................................................... 2819
AcousticReturnLoss ..................................................................................................................... 2819
DataModelObjectCategory ................................................................................................... 2823
FrequencyRange ................................................................................................................... 2823
InputPort .............................................................................................................................. 2823
InternalObject ...................................................................................................................... 2823
MaximumFrequency ............................................................................................................. 2824
MinimumFrequency ............................................................................................................. 2824
AcousticSoundPressureLevel ....................................................................................................... 2824
DataModelObjectCategory ................................................................................................... 2828
InternalObject ...................................................................................................................... 2828
AcousticTotalVelocityResult ......................................................................................................... 2828
DataModelObjectCategory ................................................................................................... 2832
InternalObject ...................................................................................................................... 2832
AcousticTransmissionLoss ........................................................................................................... 2833
DataModelObjectCategory ................................................................................................... 2837
FrequencyRange ................................................................................................................... 2837

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

InputPort .............................................................................................................................. 2837

InternalObject ...................................................................................................................... 2837
MaximumFrequency ............................................................................................................. 2837
MinimumFrequency ............................................................................................................. 2837
OutputPort ........................................................................................................................... 2838
Ansys.ACT.Automation.Mechanical.MeshControls Namespace ..................................................... 2839
AutomaticMethod ...................................................................................................................... 2839
Active ................................................................................................................................... 2842
AggressiveInflateOption ....................................................................................................... 2842
AggressiveTetImprovement .................................................................................................. 2843
Algorithm ............................................................................................................................. 2843
ApproximativeNumberOfElementsPerPart ............................................................................. 2843
BFCartSubType ..................................................................................................................... 2843
BFCartTolerance .................................................................................................................... 2843
CartesianSize ........................................................................................................................ 2843
ConstrainBoundary ............................................................................................................... 2844
ControlMessages .................................................................................................................. 2844
CoordinateSystem ................................................................................................................ 2844
CornerAngle ......................................................................................................................... 2844
CurvatureNormalAngle ......................................................................................................... 2844
DataModelObjectCategory ................................................................................................... 2844
DefeatureLayerVolume ......................................................................................................... 2845
DefeaturingTolerance ........................................................................................................... 2845
DefinedBy ............................................................................................................................. 2845
ElementMidsideNodes ***OBSOLETE*** Use the ElementOrder property instead. ................... 2845
ElementOption ..................................................................................................................... 2845
ElementOrder ....................................................................................................................... 2845
FeatureAngle ........................................................................................................................ 2846
FreeFaceMeshType ............................................................................................................... 2846
FreeMeshType ...................................................................................................................... 2846
GenerateLayersUsingFacets .................................................................................................. 2846
InflateRelativeTolerance ........................................................................................................ 2846
InternalObject ...................................................................................................................... 2846
KeyPointsSelection ............................................................................................................... 2847
LayerHeight .......................................................................................................................... 2847
LayerStart ............................................................................................................................. 2847
Location ............................................................................................................................... 2847
MappedMeshType ................................................................................................................ 2847
MatchMeshWherePossible .................................................................................................... 2847
MaximumElementSize .......................................................................................................... 2848
MeshBasedDefeaturing ......................................................................................................... 2848
MeshInCenter ....................................................................................................................... 2848
MeshUsingVoxelization ......................................................................................................... 2848
Method ................................................................................................................................ 2848
MinimumEdgeLength ........................................................................................................... 2848
MinimumSizeLimit ................................................................................................................ 2849
NumberOfCellsAcrossGap ..................................................................................................... 2849
OverlappingAngle ................................................................................................................ 2849
ParticleDiameter ................................................................................................................... 2849
PreserveBoundaries .............................................................................................................. 2849
ProjectCornersToTop ............................................................................................................. 2849

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

ProjectInConstantZPlane ....................................................................................................... 2850

ProjectionFactor ................................................................................................................... 2850
Refinement ........................................................................................................................... 2850
RelativeTolerance .................................................................................................................. 2850
RepairFacets ......................................................................................................................... 2850
ReuseBlocking ...................................................................................................................... 2850
SlicerFeatureAngle ................................................................................................................ 2851
SliverTriangleHeight ............................................................................................................. 2851
SmoothTransition ................................................................................................................. 2851
SourceLocation ..................................................................................................................... 2851
SourceTargetSelection .......................................................................................................... 2851
SpacingOption ..................................................................................................................... 2851
SplitAngle ............................................................................................................................. 2852
StretchFactorX ...................................................................................................................... 2852
StretchFactorY ...................................................................................................................... 2852
StretchFactorZ ...................................................................................................................... 2852
SubsampleRate ..................................................................................................................... 2852
SurfaceMeshMethod ............................................................................................................. 2852
SweepBiasType ..................................................................................................................... 2853
SweepBiasValue .................................................................................................................... 2853
SweepEdges ......................................................................................................................... 2853
SweepElementSize ................................................................................................................ 2853
SweepESizeType ................................................................................................................... 2853
SweepNumberDivisions ........................................................................................................ 2853
SweepSizeBehavior ............................................................................................................... 2854
SweepThickness ................................................................................................................... 2854
TargetLocation ...................................................................................................................... 2854
TetraGrowthRate ................................................................................................................... 2854
UseSplitAngle ....................................................................................................................... 2854
WallThickness ....................................................................................................................... 2854
WriteICEMCFDFiles ............................................................................................................... 2855
Connect ...................................................................................................................................... 2855
ConnectionOption ................................................................................................................ 2856
ConnectionSize ..................................................................................................................... 2856
ConnectionTolerance ............................................................................................................ 2856
ConnectionToleranceList ....................................................................................................... 2856
CoplanarAngleTolerance ....................................................................................................... 2856
DataModelObjectCategory ................................................................................................... 2856
InternalObject ...................................................................................................................... 2857
Location ............................................................................................................................... 2857
MultipleConnectionStep ....................................................................................................... 2857
NamedSelection ................................................................................................................... 2857
PerformIntersections ............................................................................................................ 2857
ContactSizing ............................................................................................................................. 2857
ContactRegion ...................................................................................................................... 2858
DataModelObjectCategory ................................................................................................... 2858
ElementSize .......................................................................................................................... 2859
InternalObject ...................................................................................................................... 2859
Relevance ............................................................................................................................. 2859
Type ..................................................................................................................................... 2859
Deviation .................................................................................................................................... 2859

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

ControlType .......................................................................................................................... 2860

DataModelObjectCategory ................................................................................................... 2860
InternalObject ...................................................................................................................... 2860
Location ............................................................................................................................... 2861
MeshSize .............................................................................................................................. 2861
NumberOfDivisions .............................................................................................................. 2861
Tolerance .............................................................................................................................. 2861
FaceMeshing .............................................................................................................................. 2861
Active ................................................................................................................................... 2862
ConstrainBoundary ............................................................................................................... 2862
DataModelObjectCategory ................................................................................................... 2862
InternalNumberOfDivisions ................................................................................................... 2863
InternalObject ...................................................................................................................... 2863
Location ............................................................................................................................... 2863
MappedMesh ....................................................................................................................... 2863
Method ................................................................................................................................ 2863
SpecifiedCorners ................................................................................................................... 2863
SpecifiedEnds ....................................................................................................................... 2864
SpecifiedSides ...................................................................................................................... 2864
FeatureSuppress ......................................................................................................................... 2864
DataModelObjectCategory ................................................................................................... 2865
FeatureHeight ....................................................................................................................... 2865
InternalObject ...................................................................................................................... 2865
Location ............................................................................................................................... 2865
SourceLocation ..................................................................................................................... 2865
SourceSelection .................................................................................................................... 2866
Inflation ...................................................................................................................................... 2866
Active ................................................................................................................................... 2867
AspectRatio .......................................................................................................................... 2867
BoundaryLocation ................................................................................................................ 2867
DataModelObjectCategory ................................................................................................... 2867
FirstLayerHeight ................................................................................................................... 2867
GrowthRate .......................................................................................................................... 2868
InflationAlgorithm ................................................................................................................ 2868
InflationOption ..................................................................................................................... 2868
InternalObject ...................................................................................................................... 2868
Location ............................................................................................................................... 2868
MaximumLayers ................................................................................................................... 2868
MaximumThickness .............................................................................................................. 2869
NumberOfLayers ................................................................................................................... 2869
TransitionRatio ...................................................................................................................... 2869
MatchControl ............................................................................................................................. 2869
ControlMessages .................................................................................................................. 2870
DataModelObjectCategory ................................................................................................... 2870
HighCoordinateSystem ......................................................................................................... 2870
HighGeometrySelection ........................................................................................................ 2870
InternalObject ...................................................................................................................... 2871
LowCoordinateSystem .......................................................................................................... 2871
LowGeometrySelection ......................................................................................................... 2871
RotationAxis ......................................................................................................................... 2871
Transformation ..................................................................................................................... 2871

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

Mesh .......................................................................................................................................... 2871

AspectRatio .......................................................................................................................... 2878
AutomaticMeshBasedDefeaturing ......................................................................................... 2878
Average ................................................................................................................................ 2878
CaptureCurvature ................................................................................................................. 2879
CaptureProximity .................................................................................................................. 2879
CheckMeshQuality ................................................................................................................ 2879
Children ............................................................................................................................... 2879
CollisionAvoidance ............................................................................................................... 2879
Comments ............................................................................................................................ 2879
ConnectionSize ..................................................................................................................... 2880
ConnectionTolerance ............................................................................................................ 2880
ConnectionToleranceList ....................................................................................................... 2880
ConnectionToleranceType ..................................................................................................... 2880
CoplanarAngleTol ................................................................................................................. 2880
CreateInflatedTets ................................................................................................................. 2880
CurrentConfiguration ............................................................................................................ 2881
CurvatureNormalAngle ......................................................................................................... 2881
DataModelObjectCategory ................................................................................................... 2881
DefeatureTolerance ............................................................................................................... 2881
DisplayStyle .......................................................................................................................... 2881
ElementOrder ....................................................................................................................... 2881
Elements .............................................................................................................................. 2882
ElementSize .......................................................................................................................... 2882
ExportFormat ....................................................................................................................... 2882
ExportUnit ............................................................................................................................ 2882
ExtraRetriesForAssembly ....................................................................................................... 2882
Figures ................................................................................................................................. 2882
FilletRatio ............................................................................................................................. 2883
FirstLayerHeight ................................................................................................................... 2883
GeneratePinchOnRefresh ...................................................................................................... 2883
GrowthRate .......................................................................................................................... 2883
GrowthRateSF ....................................................................................................................... 2883
GrowthRateType ................................................................................................................... 2883
HoleRemovalTolerance ......................................................................................................... 2884
Images ................................................................................................................................. 2884
InflationAlgorithm ................................................................................................................ 2884
InflationOption ..................................................................................................................... 2884
InitialSizeSeed ...................................................................................................................... 2884
InternalObject ...................................................................................................................... 2884
LocalConnectionOption ........................................................................................................ 2885
LocalConnectionTolerance .................................................................................................... 2885
Maximum ............................................................................................................................. 2885
MaximumAngle .................................................................................................................... 2885
MaximumHeightOverBase .................................................................................................... 2885
MaximumLayers ................................................................................................................... 2885
MaximumSize ....................................................................................................................... 2886
MaximumThickness .............................................................................................................. 2886
MeshBasedConnection ......................................................................................................... 2886
MeshMetric .......................................................................................................................... 2886
MeshMorphing ..................................................................................................................... 2886

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

Method ................................................................................................................................ 2886

MinimizeNumTriangles ......................................................................................................... 2887
Minimum .............................................................................................................................. 2887
MinimumEdgeLength ........................................................................................................... 2887
MinimumSize ....................................................................................................................... 2887
MultiConnectionSteps .......................................................................................................... 2887
NamedSelection ................................................................................................................... 2887
Nodes ................................................................................................................................... 2888
NumberOfCPUsForParallelPartMeshing ................................................................................. 2888
NumberOfRetries .................................................................................................................. 2888
NumberOfShellMeshQualityMetrics ...................................................................................... 2888
PhysicsPreference ................................................................................................................. 2888
PinchTolerance ..................................................................................................................... 2888
ProximityGapFactor .............................................................................................................. 2889
ProximityMinimumSize ......................................................................................................... 2889
ProximitySizeSources ............................................................................................................ 2889
QuadMesh ............................................................................................................................ 2889
ReadOnly .............................................................................................................................. 2889
Relevance ............................................................................................................................. 2889
RelevanceCenter ................................................................................................................... 2890
Resolution ............................................................................................................................ 2890
RigidBodyBehavior ............................................................................................................... 2890
RigidBodyFaceMeshType ...................................................................................................... 2890
ShapeChecking ..................................................................................................................... 2890
SheetLoopRemoval ............................................................................................................... 2890
Smoothing ........................................................................................................................... 2891
SmoothingIterations ............................................................................................................. 2891
SolverPreference ................................................................................................................... 2891
SpanAngleCenter .................................................................................................................. 2891
StandardDeviation ................................................................................................................ 2891
StraightSidedElements .......................................................................................................... 2891
TargetCharacteristicLength ................................................................................................... 2892
TargetExplicitAspectRatio ..................................................................................................... 2892
TargetQuality ........................................................................................................................ 2892
TargetSkewness .................................................................................................................... 2892
TopologyChecking ................................................................................................................ 2892
TransitionOption ................................................................................................................... 2892
TransitionRatio ...................................................................................................................... 2893
TriangleSurfaceMesher ......................................................................................................... 2893
UseAdaptiveSizing ................................................................................................................ 2893
UseAdvancedSizeFunction .................................................................................................... 2893
UseAutomaticInflation .......................................................................................................... 2893
UseFixedSizeFunctionForSheets ............................................................................................ 2893
UsePostSmoothing ............................................................................................................... 2894
UseSheetThicknessForPinch .................................................................................................. 2894
ViewAdvancedOptions ......................................................................................................... 2894
Worksheet ............................................................................................................................ 2894
AddAutomaticMethod() ........................................................................................................ 2894
AddComment() ..................................................................................................................... 2894
AddContactMatchGroup() ..................................................................................................... 2895
AddContactSizing() ............................................................................................................... 2895

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

AddDeviation() ..................................................................................................................... 2895

AddDirectMorph() ................................................................................................................ 2895
AddFaceMeshing() ................................................................................................................ 2895
AddFigure() .......................................................................................................................... 2895
AddImage(string) .................................................................................................................. 2896
AddInflation() ....................................................................................................................... 2896
AddManualMeshConnection() .............................................................................................. 2896
AddMatchControl() ............................................................................................................... 2896
AddMeshConnectionGroup() ................................................................................................ 2896
AddNodeMerge() .................................................................................................................. 2897
AddNodeMergeGroup() ........................................................................................................ 2897
AddPinch() ........................................................................................................................... 2897
AddPullExtrude() .................................................................................................................. 2897
AddPullRevolve() .................................................................................................................. 2897
AddPullSurfaceCoating() ....................................................................................................... 2897
AddRefinement() .................................................................................................................. 2898
AddSizing() ........................................................................................................................... 2898
AddWasher() ......................................................................................................................... 2898
AddWeld() ............................................................................................................................ 2898
CleanPartOrBody(IDataModelObject) .................................................................................... 2898
CleanPartOrBody(IEnumerable) ............................................................................................. 2899
ClearGeneratedData() ........................................................................................................... 2899
CreateMQSurfaceElementsNamedSelection(MeshMetricType, uint) ....................................... 2899
CreateMQVolumeElementsNamedSelection(MeshMetricType, uint) ....................................... 2899
CreatePinchControls() ........................................................................................................... 2900
GenerateMesh() .................................................................................................................... 2900
GetActiveSurfaceMeshQuality(MeshMetricType) ................................................................... 2900
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2900
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2901
GetIsShellTargetMetric(MeshMetricType) .............................................................................. 2901
GetIsSolidTargetMetric(MeshMetricType) .............................................................................. 2902
GetSurfaceMeshQualityCountFailed(MeshMetricType) .......................................................... 2902
GetSurfaceMeshQualityErrorLimit(MeshMetricType) .............................................................. 2902
GetSurfaceMeshQualityName(MeshMetricType) .................................................................... 2903
GetSurfaceMeshQualityPercentageFailed(MeshMetricType) ................................................... 2903
GetSurfaceMeshQualityWarningLimit(MeshMetricType) ........................................................ 2903
GetSurfaceMeshQualityWorstMetricValue(MeshMetricType) .................................................. 2903
GetVolumeMeshQualityCountFailed(MeshMetricType) .......................................................... 2904
GetVolumeMeshQualityErrorLimit(MeshMetricType) ............................................................. 2904
GetVolumeMeshQualityName(MeshMetricType) ................................................................... 2904
GetVolumeMeshQualityPercentageFailed(MeshMetricType) .................................................. 2905
GetVolumeMeshQualityWarningLimit(MeshMetricType) ........................................................ 2905
GetVolumeMeshQualityWorstMetricBackgroundColor(MeshMetricType) ............................... 2905
GetVolumeMeshQualityWorstMetricValue(MeshMetricType) .................................................. 2905
IsMeshMetricVisible(uint) ...................................................................................................... 2906
PinchControlGeomtry(MeshControlPinchGeomtryType) ........................................................ 2906
PreviewInflation() .................................................................................................................. 2906
PreviewMeshOnAllWelds() .................................................................................................... 2906
PreviewMeshOnWeld(IDataModelObject) .............................................................................. 2907
PreviewMeshOnWeldCurve(IDataModelObject) ..................................................................... 2907
PreviewMeshOnWelds(IEnumerable) ..................................................................................... 2907

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

PreviewMeshOnWeldWorksheet(IDataModelObject, IEnumerable<int>) ................................ 2907

PreviewSurfaceMesh() ........................................................................................................... 2908
PreviewWelds() ..................................................................................................................... 2908
SetActiveSurfaceMeshQuality(MeshMetricType, double) ........................................................ 2908
SetActiveVolumeMeshQuality(MeshMetricType, double) ....................................................... 2909
SetSurfaceMeshQualityErrorLimit(MeshMetricType, double) .................................................. 2909
SetSurfaceMeshQualityErrorLimit(MeshMetricType, Quantity) ................................................ 2909
SetSurfaceMeshQualityWarningLimit(MeshMetricType, double) ............................................. 2910
SetSurfaceMeshQualityWarningLimit(MeshMetricType, Quantity) .......................................... 2910
SetVolumeMeshQualityErrorLimit(MeshMetricType, double) .................................................. 2910
SetVolumeMeshQualityErrorLimit(MeshMetricType, Quantity) ............................................... 2911
SetVolumeMeshQualityWarningLimit(MeshMetricType, double) ............................................ 2911
SetVolumeMeshQualityWarningLimit(MeshMetricType, Quantity) .......................................... 2911
ShowFeatureSuppressibleFaces() .......................................................................................... 2912
ShowMappableBodies() ........................................................................................................ 2912
ShowOverlappingFaces() ...................................................................................................... 2912
ShowSweepableBodies() ....................................................................................................... 2912
ShowUnconnectedFacesNearEdges() .................................................................................... 2913
Update() ............................................................................................................................... 2913
MeshControl ............................................................................................................................... 2913
Children ............................................................................................................................... 2914
Comments ............................................................................................................................ 2914
DataModelObjectCategory ................................................................................................... 2914
Figures ................................................................................................................................. 2914
Images ................................................................................................................................. 2914
InternalObject ...................................................................................................................... 2914
ScopingMethod .................................................................................................................... 2915
Suppressed ........................................................................................................................... 2915
AddComment() ..................................................................................................................... 2915
AddFigure() .......................................................................................................................... 2915
AddImage(string) .................................................................................................................. 2915
Delete() ................................................................................................................................ 2916
GenerateMesh() .................................................................................................................... 2916
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2916
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2916
RenameBasedOnDefinition() ................................................................................................. 2917
Pinch .......................................................................................................................................... 2917
AutoManualMode ................................................................................................................. 2918
DataModelObjectCategory ................................................................................................... 2918
InternalObject ...................................................................................................................... 2918
MasterGeometry ................................................................................................................... 2918
SlaveGeometry ..................................................................................................................... 2919
Tolerance .............................................................................................................................. 2919
Refinement ................................................................................................................................. 2919
DataModelObjectCategory ................................................................................................... 2920
InternalObject ...................................................................................................................... 2920
Location ............................................................................................................................... 2920
NumberOfRefinements ......................................................................................................... 2920
Relevance ................................................................................................................................... 2920
DataModelObjectCategory ................................................................................................... 2921
InternalObject ...................................................................................................................... 2921

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

Location ............................................................................................................................... 2921

PartRelavance ....................................................................................................................... 2922
RepairTopology .......................................................................................................................... 2922
CollapseShortEdges .............................................................................................................. 2924
DataModelObjectCategory ................................................................................................... 2924
FillHole ................................................................................................................................. 2924
FillHolesGeometrySelection .................................................................................................. 2924
FillHolesNamedSelection ...................................................................................................... 2924
InternalObject ...................................................................................................................... 2924
MergeFaces .......................................................................................................................... 2925
MergeFacesGeometrySelection ............................................................................................. 2925
MergeFacesNamedSelection ................................................................................................. 2925
PinchFaces ............................................................................................................................ 2925
PinchFacesGeometrySelection .............................................................................................. 2925
PinchFacesNamedSelection .................................................................................................. 2925
PinchFacesUseLocalScoping .................................................................................................. 2926
PinchTolerance ..................................................................................................................... 2926
RemoveSharpAngleFaces ...................................................................................................... 2926
RemoveThinFaces ................................................................................................................. 2926
ScopingForFillHole ................................................................................................................ 2926
ScopingForMerge ................................................................................................................. 2926
ScopingForPinchFaces .......................................................................................................... 2927
ScopingForSharpAngle ......................................................................................................... 2927
ScopingForShortEdges .......................................................................................................... 2927
ScopingForSupressEdges ...................................................................................................... 2927
ScopingForThinFaces ............................................................................................................ 2927
SharpAngle ........................................................................................................................... 2927
SharpAngleFacesUseLocalScoping ........................................................................................ 2928
SharpAnglesGeometrySelection ............................................................................................ 2928
SharpAnglesNamedSelection ................................................................................................ 2928
ShortEdgeLength ................................................................................................................. 2928
ShortEdgesGeometrySelection ............................................................................................. 2928
ShortEdgesNamedSelection .................................................................................................. 2928
ShortEdgesUseLocalScoping ................................................................................................. 2929
SuppressEdges ..................................................................................................................... 2929
SuppressEdgesGeometrySelection ........................................................................................ 2929
SupressEdgesNamedSelection .............................................................................................. 2929
ThinFacesGeometrySelection ................................................................................................ 2929
ThinFacesNamedSelection .................................................................................................... 2929
ThinFacesUseLocalScoping ................................................................................................... 2930
ThinFaceWidth ...................................................................................................................... 2930
Sizing ......................................................................................................................................... 2930
Active ................................................................................................................................... 2931
Behavior ............................................................................................................................... 2931
BiasFactor ............................................................................................................................. 2931
BiasGrowthRate .................................................................................................................... 2932
BiasOption ............................................................................................................................ 2932
BiasType ............................................................................................................................... 2932
BodyOfInfluence ................................................................................................................... 2932
CurvatureNormalAngle ......................................................................................................... 2932
DataModelObjectCategory ................................................................................................... 2932

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

ElementSize .......................................................................................................................... 2933

GrowthRate .......................................................................................................................... 2933
InternalObject ...................................................................................................................... 2933
LocalMinimumSize ................................................................................................................ 2933
Location ............................................................................................................................... 2933
NumberOfDivisions .............................................................................................................. 2933
OriginX ................................................................................................................................. 2934
OriginY ................................................................................................................................. 2934
OriginZ ................................................................................................................................. 2934
ReverseBias .......................................................................................................................... 2934
SphereCenter ....................................................................................................................... 2934
SphereRadius ....................................................................................................................... 2934
Type ..................................................................................................................................... 2935
Washer ....................................................................................................................................... 2935
DataModelObjectCategory ................................................................................................... 2936
FactorOfDiameter ................................................................................................................. 2936
GrowthRate .......................................................................................................................... 2936
InternalObject ...................................................................................................................... 2936
Location ............................................................................................................................... 2936
MinimumNumberOfWasherDivisions .................................................................................... 2937
NumberOfWasherDivisions ................................................................................................... 2937
NumberOfWasherLayers ....................................................................................................... 2937
WasherLayerHeight ............................................................................................................... 2937
WasherMethod ..................................................................................................................... 2937
WasherType .......................................................................................................................... 2937
Weld ........................................................................................................................................... 2938
AdjustWeldHeight ................................................................................................................ 2943
AngledDirection ................................................................................................................... 2943
BottomEntities ...................................................................................................................... 2944
ConnectionTolerance ............................................................................................................ 2944
ControlType .......................................................................................................................... 2944
CreateHAZLayer .................................................................................................................... 2944
CreateUsing .......................................................................................................................... 2944
CreationCriteria .................................................................................................................... 2944
CrossSectionId ...................................................................................................................... 2945
CurveScoping ....................................................................................................................... 2945
DataModelObjectCategory ................................................................................................... 2945
EdgeMeshSize ...................................................................................................................... 2945
EdgeSelection ....................................................................................................................... 2945
GenerateEndCaps ................................................................................................................. 2945
GenerateNamedSelection ..................................................................................................... 2946
HAZDistance ......................................................................................................................... 2946
HAZDistanceAssignment ...................................................................................................... 2946
HAZDistanceExpression ........................................................................................................ 2946
HAZGrowthRate .................................................................................................................... 2946
InternalObject ...................................................................................................................... 2946
LapWeldAngleTolerance ....................................................................................................... 2947
MaterialId ............................................................................................................................. 2947
MaxThicknessFactor .............................................................................................................. 2947
MinThicknessFactor .............................................................................................................. 2947
ModeledAs ........................................................................................................................... 2947

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

NameFilter ............................................................................................................................ 2947

NumberOfLayers ................................................................................................................... 2948
NumberOfWelds ................................................................................................................... 2948
Offset1 ................................................................................................................................. 2948
Offset2 ................................................................................................................................. 2948
SharpAngle ........................................................................................................................... 2948
Smoothing ........................................................................................................................... 2948
Source .................................................................................................................................. 2949
Thickness .............................................................................................................................. 2949
ThicknessAssignment ........................................................................................................... 2949
TopEntities ........................................................................................................................... 2949
UseWorksheet ...................................................................................................................... 2949
WeldAngle ............................................................................................................................ 2949
WeldControlWeldWidth ........................................................................................................ 2950
WeldCurves .......................................................................................................................... 2950
WeldCurvesBody .................................................................................................................. 2950
WeldDefinitionFileLocation ................................................................................................... 2950
WeldHeight .......................................................................................................................... 2950
WeldHeightAssignment ........................................................................................................ 2950
WeldHeightExpression .......................................................................................................... 2951
WeldIntersectionTag ............................................................................................................. 2951
WeldIntersectionTolerance .................................................................................................... 2951
WeldLength .......................................................................................................................... 2951
WeldPitch ............................................................................................................................. 2951
WeldThicknessExpression ..................................................................................................... 2951
WeldWidthAssignment ......................................................................................................... 2952
WeldWidthExpression ........................................................................................................... 2952
WriteDefinitionFile ................................................................................................................ 2952
ActivateAllWorksheetEntries() ............................................................................................... 2952
AddWeldWorksheetScopeToSelection(int, int) ....................................................................... 2952
AppendWeldControlIntersectionTag(string) .......................................................................... 2953
AppendWeldWorksheetIntersectionTag(IEnumerable<int>, string) ........................................ 2953
ClearAutoWeldIntersectionTag(bool) ..................................................................................... 2953
ClearWeldControlIntersectionTag() ........................................................................................ 2953
ClearWeldWorksheetIntersectionTag(IEnumerable<int>) ....................................................... 2954
DeactivateAllWorksheetEntries() ........................................................................................... 2954
DeactivateProblematicWorksheetEntries() ............................................................................. 2954
GenerateWeldIntersectionTag() ............................................................................................. 2954
GetCrossSectionIds(int) ......................................................................................................... 2954
GetMaterialIds(int) ................................................................................................................ 2955
GetWeldWorksheetAbsTol(int) ............................................................................................... 2955
GetWeldWorksheetActive(int) ............................................................................................... 2955
GetWeldWorksheetBottomEntities(int) .................................................................................. 2956
GetWeldWorksheetCrossSectionId(int) .................................................................................. 2956
GetWeldWorksheetEdgeMeshSize(int) ................................................................................... 2956
GetWeldWorksheetEdges(int) ................................................................................................ 2957
GetWeldWorksheetGenerateEndCaps(int) ............................................................................. 2957
GetWeldWorksheetHAZDistance(int) ..................................................................................... 2957
GetWeldWorksheetHAZDistanceExpression(int) .................................................................... 2957
GetWeldWorksheetHAZGrowthRate(int) ................................................................................ 2958
GetWeldWorksheetHeight(int) .............................................................................................. 2958

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

GetWeldWorksheetIntersectionTag(int) ................................................................................. 2958

GetWeldWorksheetLapAngleTol(int) ...................................................................................... 2959
GetWeldWorksheetLength(int) .............................................................................................. 2959
GetWeldWorksheetMaterialId(int) ......................................................................................... 2959
GetWeldWorksheetMaxThicknessFactor(int) .......................................................................... 2959
GetWeldWorksheetMinThicknessFactor(int) .......................................................................... 2960
GetWeldWorksheetNumError() .............................................................................................. 2960
GetWeldWorksheetNumLayers(int) ........................................................................................ 2960
GetWeldWorksheetNumWarning() ........................................................................................ 2960
GetWeldWorksheetNumWelds(int) ........................................................................................ 2961
GetWeldWorksheetOffset1(int) .............................................................................................. 2961
GetWeldWorksheetOffset2(int) .............................................................................................. 2961
GetWeldWorksheetPitch(int) ................................................................................................. 2961
GetWeldWorksheetSharpAngle(int) ....................................................................................... 2962
GetWeldWorksheetSmoothing(int) ........................................................................................ 2962
GetWeldWorksheetThickness(int) .......................................................................................... 2962
GetWeldWorksheetThicknessExpression(int) ......................................................................... 2963
GetWeldWorksheetTopEntities(int) ........................................................................................ 2963
GetWeldWorksheetWeldAngle(int) ........................................................................................ 2963
GetWeldWorksheetWeldCurve(int) ........................................................................................ 2963
GetWeldWorksheetWeldHeightExpression(int) ...................................................................... 2964
GetWeldWorksheetWeldWidthExpression(int) ....................................................................... 2964
GetWeldWorksheetWidth(int) ............................................................................................... 2964
PreviewMeshOnWeldWorksheet(IEnumerable<int>) .............................................................. 2965
PromoteToWeldControl(IEnumerable<int>) ........................................................................... 2965
SetWeldWorksheetAbsTol(IEnumerable<int>, double) ........................................................... 2965
SetWeldWorksheetActive(IEnumerable<int>, bool) ................................................................ 2966
SetWeldWorksheetBottomEntities(IEnumerable<int>, uint) ................................................... 2966
SetWeldWorksheetCrossSectionId(IEnumerable<int>, int) ...................................................... 2966
SetWeldWorksheetEdgeMeshSize(IEnumerable<int>, double) ............................................... 2967
SetWeldWorksheetEdges(IEnumerable<int>, uint) ................................................................. 2967
SetWeldWorksheetGenerateEndCaps(IEnumerable<int>, bool) .............................................. 2967
SetWeldWorksheetHAZDistance(IEnumerable<int>, double) .................................................. 2968
SetWeldWorksheetHAZDistanceExpression(IEnumerable<int>, string) ................................... 2968
SetWeldWorksheetHAZGrowthRate(IEnumerable<int>, double) ............................................. 2968
SetWeldWorksheetHeight(IEnumerable<int>, double) ........................................................... 2969
SetWeldWorksheetIntersectionTag(IEnumerable<int>, string) ................................................ 2969
SetWeldWorksheetLapAngleTol(IEnumerable<int>, double) .................................................. 2970
SetWeldWorksheetLength(IEnumerable<int>, double) ........................................................... 2970
SetWeldWorksheetMaterialId(IEnumerable<int>, int) ............................................................. 2970
SetWeldWorksheetMaxThicknessFactor(IEnumerable<int>, double) ....................................... 2971
SetWeldWorksheetMinThicknessFactor(IEnumerable<int>, double) ....................................... 2971
SetWeldWorksheetNumLayers(IEnumerable<int>, int) ........................................................... 2971
SetWeldWorksheetNumWelds(IEnumerable<int>, int) ............................................................ 2972
SetWeldWorksheetOffset1(IEnumerable<int>, double) .......................................................... 2972
SetWeldWorksheetOffset2(IEnumerable<int>, double) .......................................................... 2972
SetWeldWorksheetPitch(IEnumerable<int>, double) .............................................................. 2973
SetWeldWorksheetSharpAngle(IEnumerable<int>, double) .................................................... 2973
SetWeldWorksheetSmoothing(IEnumerable<int>, bool) ........................................................ 2974
SetWeldWorksheetThickness(IEnumerable<int>, double) ....................................................... 2974
SetWeldWorksheetThicknessExpression(IEnumerable<int>, string) ........................................ 2974

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

SetWeldWorksheetTopEntities(IEnumerable<int>, uint) ......................................................... 2975

SetWeldWorksheetWeldAngle(IEnumerable<int>, double) ..................................................... 2975
SetWeldWorksheetWeldCurve(IEnumerable<int>, uint) .......................................................... 2975
SetWeldWorksheetWeldHeightExpression(IEnumerable<int>, string) ..................................... 2976
SetWeldWorksheetWeldWidthExpression(IEnumerable<int>, string) ...................................... 2976
SetWeldWorksheetWidth(IEnumerable<int>, double) ............................................................ 2976
WeldWorksheetAddEntry() .................................................................................................... 2977
WeldWorksheetCreateControlForCurveBodies() ..................................................................... 2977
WeldWorksheetDeleteEntry(IEnumerable<int>) .................................................................... 2977
WeldWorksheetExport(string) ............................................................................................... 2977
WeldWorksheetImport(string) ............................................................................................... 2978
WeldWorksheetNumEntries() ................................................................................................ 2978
WeldWorksheetStatus(int) ..................................................................................................... 2978
Ansys.ACT.Automation.Mechanical.ImportedLoads Namespace .................................................. 2979
ImportedBodyForceDensity ........................................................................................................ 2980
DataModelObjectCategory ................................................................................................... 2983
InternalObject ...................................................................................................................... 2983
GetActivateAtLoadStep(uint) ................................................................................................ 2983
SetActivateAtLoadStep(uint, bool) ......................................................................................... 2983
ImportedBodyTemperature ......................................................................................................... 2984
ApplyToInitialMesh ............................................................................................................... 2987
DataModelObjectCategory ................................................................................................... 2987
InternalObject ...................................................................................................................... 2987
GetActivateAtLoadStep(uint) ................................................................................................ 2988
SetActivateAtLoadStep(uint, bool) ......................................................................................... 2988
ImportedConvection ................................................................................................................... 2988
DataModelObjectCategory ................................................................................................... 2992
DisplayConnectionLines ........................................................................................................ 2992
FluidFlow .............................................................................................................................. 2992
FluidFlowLocation ................................................................................................................ 2992
InternalObject ...................................................................................................................... 2992
GetActivateAtLoadStep(uint) ................................................................................................ 2992
SetActivateAtLoadStep(uint, bool) ......................................................................................... 2993
ImportedCutBoundaryRemoteConstraint .................................................................................... 2993
DataModelObjectCategory ................................................................................................... 2996
InternalObject ...................................................................................................................... 2997
GetActivateAtLoadStep(uint) ................................................................................................ 2997
SetActivateAtLoadStep(uint, bool) ......................................................................................... 2997
ImportedCutBoundaryRemoteForce ............................................................................................ 2997
DataModelObjectCategory ................................................................................................... 3001
InternalObject ...................................................................................................................... 3001
GetActivateAtLoadStep(uint) ................................................................................................ 3001
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3001
ImportedDisplacement ............................................................................................................... 3002
ApplyToInitialMesh ............................................................................................................... 3005
DataModelObjectCategory ................................................................................................... 3005
DisplacementType ................................................................................................................ 3005
InternalObject ...................................................................................................................... 3006
GetActivateAtLoadStep(uint) ................................................................................................ 3006
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3006
ImportedElementOrientation ...................................................................................................... 3006

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

DataModelObjectCategory ................................................................................................... 3010

InternalObject ...................................................................................................................... 3010
ImportedFiberRatio .................................................................................................................... 3010
DataModelObjectCategory ................................................................................................... 3013
InternalObject ...................................................................................................................... 3013
ImportedForce ............................................................................................................................ 3014
DataModelObjectCategory ................................................................................................... 3017
InternalObject ...................................................................................................................... 3017
ImportedHeatFlux ....................................................................................................................... 3017
DataModelObjectCategory ................................................................................................... 3020
InternalObject ...................................................................................................................... 3020
ImportedHeatGeneration ............................................................................................................ 3021
DataModelObjectCategory ................................................................................................... 3024
InternalObject ...................................................................................................................... 3024
ImportedInitialStrain ................................................................................................................... 3024
DataModelObjectCategory ................................................................................................... 3027
InternalObject ...................................................................................................................... 3028
ImportedInitialStress ................................................................................................................... 3028
DataModelObjectCategory ................................................................................................... 3031
InternalObject ...................................................................................................................... 3031
ImportedLoad ............................................................................................................................ 3031
Algorithm ............................................................................................................................. 3033
ApplyAs ................................................................................................................................ 3033
BoundingBoxTolerance ......................................................................................................... 3034
Children ............................................................................................................................... 3034
Comments ............................................................................................................................ 3034
CreateNameSelectionForMappedNodes ................................................................................ 3034
CreateNameSelectionForOutsideNodes ................................................................................. 3034
CreateNameSelectionForUnmappedNodes ........................................................................... 3034
DataModelObjectCategory ................................................................................................... 3035
DisplayInteriorPoints ............................................................................................................. 3035
DisplayProjectionPlane ......................................................................................................... 3035
DisplaySourcePointIds .......................................................................................................... 3035
DisplaySourcePoints ............................................................................................................. 3035
ExtrapolationTolerancePercent .............................................................................................. 3035
Figures ................................................................................................................................. 3036
Images ................................................................................................................................. 3036
InternalObject ...................................................................................................................... 3036
Interpolation ........................................................................................................................ 3036
KrigingCorrelationFunction ................................................................................................... 3036
KrigingPolynom .................................................................................................................... 3036
LegendMaximum ................................................................................................................. 3037
LegendMinimum .................................................................................................................. 3037
LegendRange ....................................................................................................................... 3037
Limit ..................................................................................................................................... 3037
Location ............................................................................................................................... 3037
MappedNodesName ............................................................................................................. 3037
Mapping ............................................................................................................................... 3038
MappingControl ................................................................................................................... 3038
MaxOutsideDistance ............................................................................................................. 3038
Method ................................................................................................................................ 3038

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

NumberOfPoints ................................................................................................................... 3038

OrientationRealignment ....................................................................................................... 3038
OutsideDistanceCheck .......................................................................................................... 3039
OutsideNodesName .............................................................................................................. 3039
OutsideOption ...................................................................................................................... 3039
Pinball .................................................................................................................................. 3039
Projection ............................................................................................................................. 3039
RigidBodyTransformationType .............................................................................................. 3039
RigidTransformSourceCoordinateSystem ............................................................................... 3040
RigidTransformTargetCoordinateSystem ............................................................................... 3040
SharedRefBody ..................................................................................................................... 3040
ShellThicknessFactor ............................................................................................................. 3040
SourceMaximum ................................................................................................................... 3040
SourceMinimum ................................................................................................................... 3040
Suppressed ........................................................................................................................... 3041
UnmappedNodesName ........................................................................................................ 3041
VariableType ......................................................................................................................... 3041
Weighting ............................................................................................................................. 3041
AddComment() ..................................................................................................................... 3041
AddFigure() .......................................................................................................................... 3041
AddImage(string) .................................................................................................................. 3042
AddMappingValidation() ....................................................................................................... 3042
ClearGeneratedData() ........................................................................................................... 3042
Delete() ................................................................................................................................ 3042
ExportToTextFile(string) ........................................................................................................ 3042
GetActivateAtLoadStep(uint) ................................................................................................ 3043
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3043
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3043
Import() ................................................................................................................................ 3044
ImportLoad() ........................................................................................................................ 3044
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3044
ImportedLoadGroup ................................................................................................................... 3045
Children ............................................................................................................................... 3047
Comments ............................................................................................................................ 3047
DataModelObjectCategory ................................................................................................... 3047
DeleteMappedDataFilesAfterImport ...................................................................................... 3047
Figures ................................................................................................................................. 3047
Images ................................................................................................................................. 3047
InternalObject ...................................................................................................................... 3048
ResultFile .............................................................................................................................. 3048
ResultFileTimestamp ............................................................................................................. 3048
ResultFileUnitSystem ............................................................................................................ 3048
SourceDimension ................................................................................................................. 3048
Suppressed ........................................................................................................................... 3048
TransferStep ......................................................................................................................... 3049
TransferTemperaturesDuringSolve ........................................................................................ 3049
AddComment() ..................................................................................................................... 3049
AddFigure() .......................................................................................................................... 3049
AddImage(string) .................................................................................................................. 3049
AddImportedBodyForceDensity() .......................................................................................... 3050
AddImportedBodyTemperature() .......................................................................................... 3050

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

AddImportedConvection() .................................................................................................... 3050

AddImportedCutBoundaryConstraint() .................................................................................. 3050
AddImportedCutBoundaryRemoteConstraint() ...................................................................... 3050
AddImportedCutBoundaryRemoteForce() ............................................................................. 3051
AddImportedDisplacement() ................................................................................................. 3051
AddImportedElementOrientation() ....................................................................................... 3051
AddImportedFiberRatio() ...................................................................................................... 3051
AddImportedForce() ............................................................................................................. 3051
AddImportedHeatFlux() ........................................................................................................ 3051
AddImportedHeatGeneration() ............................................................................................. 3052
AddImportedInitialStrain() .................................................................................................... 3052
AddImportedInitialStress() .................................................................................................... 3052
AddImportedMaterialField() .................................................................................................. 3052
AddImportedPressure() ......................................................................................................... 3052
AddImportedSurfaceForceDensity() ...................................................................................... 3052
AddImportedTemperature() .................................................................................................. 3053
AddImportedThickness() ....................................................................................................... 3053
AddImportedTrace() .............................................................................................................. 3053
AddImportedVelocity() ......................................................................................................... 3053
AddImportedWarpWeftRatio() ............................................................................................... 3053
AddImportedYarnAngle() ...................................................................................................... 3053
ClearGeneratedData() ........................................................................................................... 3054
CreateBodyForceDensitiesAndSyncAnalysisSettings() ............................................................ 3054
CreateExternalLoadVelocitiesAndSyncAnalysisSettings() ........................................................ 3054
CreateSurfaceForceDensitiesAndSyncAnalysisSettings() ........................................................ 3054
CreateVelocitiesAndSyncAnalysisSettings() ............................................................................ 3054
Delete() ................................................................................................................................ 3054
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3055
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3055
GetExternalDataFiles() ........................................................................................................... 3055
ImportExternalDataFiles(ExternalDataFileCollection) ............................................................. 3056
ImportLoad() ........................................................................................................................ 3056
RefreshImportedLoad() ......................................................................................................... 3056
SetResultFile(string, WBUnitSystemType) ............................................................................... 3056
ImportedMaterialField ................................................................................................................ 3057
DataModelObjectCategory ................................................................................................... 3060
InternalObject ...................................................................................................................... 3060
ImportedPressure ....................................................................................................................... 3060
DataModelObjectCategory ................................................................................................... 3063
InternalObject ...................................................................................................................... 3064
ImportedSurfaceForceDensity ..................................................................................................... 3064
DataModelObjectCategory ................................................................................................... 3067
InternalObject ...................................................................................................................... 3067
GetActivateAtLoadStep(uint) ................................................................................................ 3067
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3068
ImportedTemperature ................................................................................................................ 3068
DataModelObjectCategory ................................................................................................... 3071
InternalObject ...................................................................................................................... 3072
GetActivateAtLoadStep(uint) ................................................................................................ 3072
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3072
ImportedThickness ..................................................................................................................... 3072

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

DataModelObjectCategory ................................................................................................... 3076

InternalObject ...................................................................................................................... 3076
ImportedTrace ............................................................................................................................ 3076
DataModelObjectCategory ................................................................................................... 3079
InternalObject ...................................................................................................................... 3079
Layers ................................................................................................................................... 3080
Vias ...................................................................................................................................... 3080
GetActivateAtLoadStep(uint) ................................................................................................ 3080
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3080
ImportedVelocity ........................................................................................................................ 3081
DataModelObjectCategory ................................................................................................... 3084
InternalObject ...................................................................................................................... 3084
GetActivateAtLoadStep(uint) ................................................................................................ 3084
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3084
ImportedWarpWeftRatio ............................................................................................................. 3085
DataModelObjectCategory ................................................................................................... 3088
InternalObject ...................................................................................................................... 3088
ImportedYarnAngle .................................................................................................................... 3088
DataModelObjectCategory ................................................................................................... 3092
InternalObject ...................................................................................................................... 3092
Ansys.ACT.Automation.Mechanical.ConstructionLines Namespace ............................................. 3093
ConstructionLine ........................................................................................................................ 3093
Comments ............................................................................................................................ 3094
DataModelObjectCategory ................................................................................................... 3095
Edges ................................................................................................................................... 3095
Figures ................................................................................................................................. 3095
Images ................................................................................................................................. 3095
InternalObject ...................................................................................................................... 3095
Planes ................................................................................................................................... 3095
Points ................................................................................................................................... 3096
AddComment() ..................................................................................................................... 3096
AddFigure() .......................................................................................................................... 3096
AddImage(string) .................................................................................................................. 3096
AddToGeometry() ................................................................................................................. 3096
CreatePlanarPoints(Plane, IEnumerable<object>) .................................................................. 3097
CreatePlane(object) .............................................................................................................. 3097
CreatePoints(IEnumerable<object>) ...................................................................................... 3097
CreateStraightLines(IEnumerable<Point>) ............................................................................. 3098
CreateStraightLines(IEnumerable<Point>, IEnumerable<IEnumerable<object>>) .................. 3098
DeleteEdges(IEnumerable<IEdge>) ....................................................................................... 3098
DeletePlane(Plane, bool) ....................................................................................................... 3099
FlipEdges(IEnumerable<IEdge>) ........................................................................................... 3099
GetPartFromGeometry() ....................................................................................................... 3099
Redo() .................................................................................................................................. 3099
RemoveFromGeometry() ....................................................................................................... 3100
Undo() .................................................................................................................................. 3100
UpdateGeometry() ................................................................................................................ 3100
Ansys.ACT.Automation.Mechanical.Connections Namespace ....................................................... 3101
AMBondConnection ................................................................................................................... 3101
Children ............................................................................................................................... 3102
Comments ............................................................................................................................ 3103

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

ContactBodies ...................................................................................................................... 3103

ContactType ......................................................................................................................... 3103
DataModelObjectCategory ................................................................................................... 3103
Figures ................................................................................................................................. 3103
Images ................................................................................................................................. 3103
InternalObject ...................................................................................................................... 3104
SourceLocation ..................................................................................................................... 3104
Suppressed ........................................................................................................................... 3104
TargetBodies ......................................................................................................................... 3104
TargetLocation ...................................................................................................................... 3104
AddCommandSnippet() ........................................................................................................ 3104
AddComment() ..................................................................................................................... 3105
AddFigure() .......................................................................................................................... 3105
AddImage(string) .................................................................................................................. 3105
Delete() ................................................................................................................................ 3105
FlipContactTarget() ............................................................................................................... 3105
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3106
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3106
RenameBasedOnDefinition() ................................................................................................. 3106
SearchConnectionsForDuplicatePairs() .................................................................................. 3107
Beam .......................................................................................................................................... 3107
BeamElementAPDLName ...................................................................................................... 3108
Children ............................................................................................................................... 3108
Comments ............................................................................................................................ 3109
CrossSection ......................................................................................................................... 3109
DataModelObjectCategory ................................................................................................... 3109
Figures ................................................................................................................................. 3109
Images ................................................................................................................................. 3109
InternalObject ...................................................................................................................... 3109
Material ................................................................................................................................ 3110
MobileAppliedBy .................................................................................................................. 3110
MobileBeamMaterial ............................................................................................................. 3110
MobileBeamRadius ............................................................................................................... 3110
MobileBehavior .................................................................................................................... 3110
MobileBody .......................................................................................................................... 3110
MobileCoordinateSystem ...................................................................................................... 3111
MobileLocation ..................................................................................................................... 3111
MobilePinballRegion ............................................................................................................. 3111
MobileXCoordinate ............................................................................................................... 3111
MobileYCoordinate ............................................................................................................... 3111
MobileZCoordinate ............................................................................................................... 3111
Radius .................................................................................................................................. 3112
ReferenceAppliedBy ............................................................................................................. 3112
ReferenceBeamMaterial ........................................................................................................ 3112
ReferenceBeamRadius .......................................................................................................... 3112
ReferenceBehavior ................................................................................................................ 3112
ReferenceBody ..................................................................................................................... 3112
ReferenceCoordinateSystem ................................................................................................. 3113
ReferenceLocation ................................................................................................................ 3113
ReferenceLocationPoint ........................................................................................................ 3113
ReferencePinballRegion ........................................................................................................ 3113

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

ReferenceXCoordinate .......................................................................................................... 3113

ReferenceYCoordinate .......................................................................................................... 3113
ReferenceZCoordinate .......................................................................................................... 3114
Scope ................................................................................................................................... 3114
Suppressed ........................................................................................................................... 3114
Visible .................................................................................................................................. 3114
AddCommandSnippet() ........................................................................................................ 3114
AddComment() ..................................................................................................................... 3114
AddFigure() .......................................................................................................................... 3115
AddImage(string) .................................................................................................................. 3115
Delete() ................................................................................................................................ 3115
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3115
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3116
PromoteToNamedSelection() ................................................................................................ 3116
PromoteToRemotePoint() ...................................................................................................... 3116
RenameBasedOnDefinition() ................................................................................................. 3116
Bearing ....................................................................................................................................... 3117
AnsBCType ........................................................................................................................... 3118
Children ............................................................................................................................... 3118
Comments ............................................................................................................................ 3119
ConnectionType ................................................................................................................... 3119
DampingC11 ........................................................................................................................ 3119
DampingC12 ........................................................................................................................ 3119
DampingC21 ........................................................................................................................ 3119
DampingC22 ........................................................................................................................ 3119
DataModelObjectCategory ................................................................................................... 3120
Figures ................................................................................................................................. 3120
Images ................................................................................................................................. 3120
InternalObject ...................................................................................................................... 3120
MobileBeamMaterial ............................................................................................................. 3120
MobileBeamRadius ............................................................................................................... 3120
MobileBehavior .................................................................................................................... 3121
MobileBody .......................................................................................................................... 3121
MobileCoordinateSystem ...................................................................................................... 3121
MobileLocation ..................................................................................................................... 3121
MobilePinballSize ................................................................................................................. 3121
MobileXCoordinate ............................................................................................................... 3121
MobileYCoordinate ............................................................................................................... 3122
MobileZCoordinate ............................................................................................................... 3122
ReferenceBeamMaterial ........................................................................................................ 3122
ReferenceBeamRadius .......................................................................................................... 3122
ReferenceBehavior ................................................................................................................ 3122
ReferenceBodyName ............................................................................................................ 3122
ReferenceCoordinateSystem ................................................................................................. 3123
ReferenceLocation ................................................................................................................ 3123
ReferencePinballRegion ........................................................................................................ 3123
ReferenceRotationPlane ........................................................................................................ 3123
ReferenceSet ***OBSOLETE*** Use 'ReferenceLocation' property instead. ............................... 3123
ReferenceXCoordinate .......................................................................................................... 3123
ReferenceYCoordinate .......................................................................................................... 3124
ReferenceZCoordinate .......................................................................................................... 3124

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

StiffnessK11 .......................................................................................................................... 3124

StiffnessK12 .......................................................................................................................... 3124
StiffnessK21 .......................................................................................................................... 3124
StiffnessK22 .......................................................................................................................... 3124
Suppressed ........................................................................................................................... 3125
AddCommandSnippet() ........................................................................................................ 3125
AddComment() ..................................................................................................................... 3125
AddFigure() .......................................................................................................................... 3125
AddImage(string) .................................................................................................................. 3125
Delete() ................................................................................................................................ 3126
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3126
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3126
PromoteToNamedSelection() ................................................................................................ 3127
PromoteToRemotePoint() ...................................................................................................... 3127
RenameBasedOnDefinition() ................................................................................................. 3127
BodyInteraction .......................................................................................................................... 3127
Breakable ............................................................................................................................. 3128
Children ............................................................................................................................... 3128
Comments ............................................................................................................................ 3129
ContactType ......................................................................................................................... 3129
DataModelObjectCategory ................................................................................................... 3129
DecayConstant ..................................................................................................................... 3129
DynamicCoefficient .............................................................................................................. 3129
Figures ................................................................................................................................. 3129
FrictionCoefficient ................................................................................................................ 3130
Images ................................................................................................................................. 3130
InternalObject ...................................................................................................................... 3130
Location ............................................................................................................................... 3130
MaximumOffset .................................................................................................................... 3130
NormalForceExponent .......................................................................................................... 3130
NormalForceLimit ................................................................................................................. 3131
NormalStressExponent ......................................................................................................... 3131
NormalStressLimit ................................................................................................................ 3131
ShearForceExponent ............................................................................................................. 3131
ShearForceLimit .................................................................................................................... 3131
ShearStressExponent ............................................................................................................ 3131
ShearStressLimit ................................................................................................................... 3132
Suppressed ........................................................................................................................... 3132
AddComment() ..................................................................................................................... 3132
AddFigure() .......................................................................................................................... 3132
AddImage(string) .................................................................................................................. 3132
Delete() ................................................................................................................................ 3133
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3133
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3133
BodyInteractions ........................................................................................................................ 3134
BodySelfContact ................................................................................................................... 3135
Children ............................................................................................................................... 3135
Comments ............................................................................................................................ 3135
ContactDetection ................................................................................................................. 3135
DataModelObjectCategory ................................................................................................... 3135
EdgeOnEdgeContact ............................................................................................................ 3136

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

ElementSelfContact .............................................................................................................. 3136

Figures ................................................................................................................................. 3136
Formulation .......................................................................................................................... 3136
Images ................................................................................................................................. 3136
InternalObject ...................................................................................................................... 3136
LimitingTimestepVelocity ...................................................................................................... 3137
ManualContactTreatment ..................................................................................................... 3137
NodalShellThickness ............................................................................................................. 3137
PinballFactor ......................................................................................................................... 3137
ShellThicknessFactor ............................................................................................................. 3137
SlidingContact ...................................................................................................................... 3137
TimestepSafetyFactor ........................................................................................................... 3138
Tolerance .............................................................................................................................. 3138
AddBodyInteraction() ............................................................................................................ 3138
AddComment() ..................................................................................................................... 3138
AddFigure() .......................................................................................................................... 3138
AddImage(string) .................................................................................................................. 3138
Delete() ................................................................................................................................ 3139
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3139
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3139
ConnectionGroup ....................................................................................................................... 3140
ActiveConnections ................................................................................................................ 3141
AutomaticFixedJoints ........................................................................................................... 3142
Children ............................................................................................................................... 3142
Comments ............................................................................................................................ 3142
Connections ......................................................................................................................... 3142
ConnectionType ................................................................................................................... 3142
CylindricalFaces .................................................................................................................... 3142
DataModelObjectCategory ................................................................................................... 3143
EdgeEdge ............................................................................................................................. 3143
EdgeOverlapTolerance .......................................................................................................... 3143
FaceAngleTolerance .............................................................................................................. 3143
FaceEdge .............................................................................................................................. 3143
FaceFace ............................................................................................................................... 3143
FaceFaceDetectionAngleTolerence ........................................................................................ 3144
FaceOverlapTolerance ........................................................................................................... 3144
Figures ................................................................................................................................. 3144
GroupBy ............................................................................................................................... 3144
Images ................................................................................................................................. 3144
InternalObject ...................................................................................................................... 3144
Location ............................................................................................................................... 3145
MinimumDistancePercentage ............................................................................................... 3145
MinimumDistanceValue ........................................................................................................ 3145
Priority ................................................................................................................................. 3145
RevoluteJoints ...................................................................................................................... 3145
SearchAcross ........................................................................................................................ 3145
Suppressed ........................................................................................................................... 3146
ThicknessScaleFactor ............................................................................................................ 3146
ToleranceSlider ..................................................................................................................... 3146
ToleranceType ...................................................................................................................... 3146
ToleranceValue ..................................................................................................................... 3146

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

UseRange ............................................................................................................................. 3146

AddComment() ..................................................................................................................... 3147
AddContactRegion() ............................................................................................................. 3147
AddFigure() .......................................................................................................................... 3147
AddImage(string) .................................................................................................................. 3147
AddInterStage() .................................................................................................................... 3147
AddJoint() ............................................................................................................................. 3148
AddSpotWeld() ..................................................................................................................... 3148
CreateAutomaticConnections() ............................................................................................. 3148
Delete() ................................................................................................................................ 3148
DeleteChildren() ................................................................................................................... 3148
DeleteChildren(bool) ............................................................................................................ 3148
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3149
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3149
RenameBasedOnChildren() ................................................................................................... 3150
RepairOverlappingContactRegions() ..................................................................................... 3150
SearchConnectionsForDuplicatePairs() .................................................................................. 3150
Connections ............................................................................................................................... 3150
Children ............................................................................................................................... 3151
Comments ............................................................................................................................ 3152
DataModelObjectCategory ................................................................................................... 3152
Figures ................................................................................................................................. 3152
FixedJoints ........................................................................................................................... 3152
GenerateAutomaticConnectionOnRefresh ............................................................................. 3152
Images ................................................................................................................................. 3152
InternalObject ...................................................................................................................... 3153
SolverFilesDirectory .............................................................................................................. 3153
TransparencyEnabled ............................................................................................................ 3153
AddAMBondConnection() ..................................................................................................... 3153
AddBeam() ........................................................................................................................... 3153
AddBearing() ........................................................................................................................ 3153
AddBodyInteraction() ............................................................................................................ 3154
AddComment() ..................................................................................................................... 3154
AddConnectionGroup() ......................................................................................................... 3154
AddContactRegion() ............................................................................................................. 3154
AddContactSolutionInformation() ......................................................................................... 3154
AddContactTool() .................................................................................................................. 3154
AddEndRelease() ................................................................................................................... 3155
AddFigure() .......................................................................................................................... 3155
AddImage(string) .................................................................................................................. 3155
AddInterStage() .................................................................................................................... 3155
AddJoint() ............................................................................................................................. 3155
AddSpotWeld() ..................................................................................................................... 3156
AddSpotWeldGroup() ........................................................................................................... 3156
AddSpring() .......................................................................................................................... 3156
CreateAutomaticConnections() ............................................................................................. 3156
ExportModelTopology(string) ............................................................................................... 3156
GenerateInitialContactResults() ............................................................................................. 3157
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3157
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3157
RepairOverlappingContactRegions() ..................................................................................... 3158

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

SearchConnectionsForDuplicatePairs() .................................................................................. 3158

ContactRegion ............................................................................................................................ 3158
AutomaticDetectionValue ..................................................................................................... 3161
AutomaticElectricCapacitance ............................................................................................... 3162
AutomaticElectricConductance ............................................................................................. 3162
AutomaticNormalStiffness ***OBSOLETE*** Use 'NormalStiffnessValueType' property in-
stead. ................................................................................................................................... 3162
AutomaticThermalConductance ............................................................................................ 3162
BeamBeamDetection ............................................................................................................ 3162
BeamBeamModel ................................................................................................................. 3162
BeamMaterialName ***OBSOLETE*** Use 'Material' property instead. .................................... 3163
BeamRadius .......................................................................................................................... 3163
Behavior ............................................................................................................................... 3163
BondedMaximumOffset ........................................................................................................ 3163
Breakable ............................................................................................................................. 3163
Children ............................................................................................................................... 3163
Comments ............................................................................................................................ 3164
ConstraintType ..................................................................................................................... 3164
ContactBodies ...................................................................................................................... 3164
ContactCenterPoint .............................................................................................................. 3164
ContactEndingPoint .............................................................................................................. 3164
ContactFormulation .............................................................................................................. 3164
ContactGeometryCorrection ................................................................................................. 3165
ContactOrientation ............................................................................................................... 3165
ContactShellFace .................................................................................................................. 3165
ContactStartingPoint ............................................................................................................ 3165
ContactType ......................................................................................................................... 3165
DataModelObjectCategory ................................................................................................... 3165
DecayConstant ..................................................................................................................... 3166
DetectionMethod ................................................................................................................. 3166
DisplayElementNormal ......................................................................................................... 3166
DynamicCoefficient .............................................................................................................. 3166
EdgeContactType ................................................................................................................. 3166
ElasticSlipTolerance .............................................................................................................. 3166
ElasticSlipToleranceFactor ..................................................................................................... 3167
ElasticSlipToleranceValue ...................................................................................................... 3167
ElectricCapacitanceValue ...................................................................................................... 3167
ElectricConductanceValue ..................................................................................................... 3167
Figures ................................................................................................................................. 3167
FlipContact ........................................................................................................................... 3167
FlipTarget ............................................................................................................................. 3168
FrictionCoefficient ................................................................................................................ 3168
Handedness ......................................................................................................................... 3168
Images ................................................................................................................................. 3168
InitialClearance ..................................................................................................................... 3168
InitialClearanceFactor ........................................................................................................... 3168
InitialClearanceValue ............................................................................................................. 3169
InterfaceTreatment ............................................................................................................... 3169
InternalObject ...................................................................................................................... 3169
Material ................................................................................................................................ 3169
MeanPitchDiameter .............................................................................................................. 3169

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

NormalForceExponent .......................................................................................................... 3169

NormalForceLimit ................................................................................................................. 3170
NormalStiffnessFactor ........................................................................................................... 3170
NormalStiffnessValue ............................................................................................................ 3170
NormalStiffnessValueType ..................................................................................................... 3170
NormalStressExponent ......................................................................................................... 3170
NormalStressLimit ................................................................................................................ 3170
PenetrationTolerance ............................................................................................................ 3171
PenetrationToleranceFactor .................................................................................................. 3171
PenetrationToleranceValue ................................................................................................... 3171
PinballFactor ......................................................................................................................... 3171
PinballRadius ........................................................................................................................ 3171
PinballRegion ....................................................................................................................... 3171
PitchDistance ........................................................................................................................ 3172
PressureAtZeroPenetration ................................................................................................... 3172
PressureAtZeroPenetrationFactor .......................................................................................... 3172
PressureAtZeroPenetrationValue ........................................................................................... 3172
Protected .............................................................................................................................. 3172
RBDContactDetection ........................................................................................................... 3172
RestitutionFactor .................................................................................................................. 3173
ScopeMode .......................................................................................................................... 3173
SharedSourceBody ............................................................................................................... 3173
SharedSourceReverseNormalLocation ................................................................................... 3173
SharedTargetBody ................................................................................................................ 3173
SharedTargetReverseNormalLocation .................................................................................... 3173
ShearForceExponent ............................................................................................................. 3174
ShearForceLimit .................................................................................................................... 3174
ShearStressExponent ............................................................................................................ 3174
ShearStressLimit ................................................................................................................... 3174
ShellThicknessEffect ............................................................................................................. 3174
SmallSliding .......................................................................................................................... 3174
SourceLocation ..................................................................................................................... 3175
StabilizationDampingFactor .................................................................................................. 3175
Suppressed ........................................................................................................................... 3175
TargetBodies ......................................................................................................................... 3175
TargetCenterPoint ................................................................................................................. 3175
TargetEndingPoint ................................................................................................................ 3175
TargetGeometryCorrection ................................................................................................... 3176
TargetLocation ...................................................................................................................... 3176
TargetOrientation ................................................................................................................. 3176
TargetShellFace ..................................................................................................................... 3176
TargetStartingPoint ............................................................................................................... 3176
ThermalConductanceValue ................................................................................................... 3176
ThreadAngle ......................................................................................................................... 3177
ThreadType .......................................................................................................................... 3177
TimeStepControls ................................................................................................................. 3177
TrimContact .......................................................................................................................... 3177
TrimTolerance ....................................................................................................................... 3177
UpdateStiffness .................................................................................................................... 3177
UserOffset ............................................................................................................................ 3178
AddCommandSnippet() ........................................................................................................ 3178

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

AddComment() ..................................................................................................................... 3178

AddFigure() .......................................................................................................................... 3178
AddImage(string) .................................................................................................................. 3178
AddPythonCodeEventBased() ............................................................................................... 3179
Delete() ................................................................................................................................ 3179
FlipContactTarget() ............................................................................................................... 3179
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3179
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3179
LoadContactRegionSettings(string) ....................................................................................... 3180
PromoteToNamedSelection() ................................................................................................ 3180
PromoteToRemotePoint() ...................................................................................................... 3180
RenameBasedOnDefinition() ................................................................................................. 3181
ResetToDefault() ................................................................................................................... 3181
ResetToDefault(bool) ............................................................................................................ 3181
SaveContactRegionSettings(string) ....................................................................................... 3181
SearchConnectionsForDuplicatePairs() .................................................................................. 3181
ContactTool ................................................................................................................................ 3182
Children ............................................................................................................................... 3182
Comments ............................................................................................................................ 3183
DataModelObjectCategory ................................................................................................... 3183
Figures ................................................................................................................................. 3183
Images ................................................................................................................................. 3183
InternalObject ...................................................................................................................... 3183
Location ............................................................................................................................... 3183
ScopingMethod .................................................................................................................... 3184
AddComment() ..................................................................................................................... 3184
AddFigure() .......................................................................................................................... 3184
AddImage(string) .................................................................................................................. 3184
ClearGeneratedData() ........................................................................................................... 3184
Delete() ................................................................................................................................ 3185
EvaluateAllResults() ............................................................................................................... 3185
GenerateInitialContactResults() ............................................................................................. 3185
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3185
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3185
Joint ........................................................................................................................................... 3186
BushingWorksheet ................................................................................................................ 3189
Children ............................................................................................................................... 3189
Comments ............................................................................................................................ 3189
ConnectionType ................................................................................................................... 3189
CurveOrientationSurface ...................................................................................................... 3189
DataModelObjectCategory ................................................................................................... 3189
EffectiveLength ..................................................................................................................... 3190
ElementCoordinateSystem .................................................................................................... 3190
Figures ................................................................................................................................. 3190
Formulation .......................................................................................................................... 3190
FrictionCoefficient ................................................................................................................ 3190
GeneralPrimitiveType ............................................................................................................ 3190
Images ................................................................................................................................. 3191
InitialPosition ........................................................................................................................ 3191
InnerRadius .......................................................................................................................... 3191
InternalObject ...................................................................................................................... 3191

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

JointElementAPDLName ....................................................................................................... 3191

JointFrictionType .................................................................................................................. 3191
MobileAppliedBy .................................................................................................................. 3192
MobileBeamMaterial ............................................................................................................. 3192
MobileBeamRadius ............................................................................................................... 3192
MobileBehavior .................................................................................................................... 3192
MobileBody .......................................................................................................................... 3192
MobileCoordinateSystem ...................................................................................................... 3192
MobileLocation ..................................................................................................................... 3193
MobilePinballRegion ............................................................................................................. 3193
OuterRadius ......................................................................................................................... 3193
RadialGapHeight .................................................................................................................. 3193
RadialGapInnerDiameter ....................................................................................................... 3193
RadialGapType ...................................................................................................................... 3193
RadialOuterDiameter ............................................................................................................ 3194
Radius .................................................................................................................................. 3194
ReferenceAppliedBy ............................................................................................................. 3194
ReferenceBeamMaterial ........................................................................................................ 3194
ReferenceBeamRadius .......................................................................................................... 3194
ReferenceBehavior ................................................................................................................ 3194
ReferenceBody ..................................................................................................................... 3195
ReferenceCoordinateSystem ................................................................................................. 3195
ReferenceLocation ................................................................................................................ 3195
ReferencePinballRegion ........................................................................................................ 3195
RestitutionFactor .................................................................................................................. 3195
Rotations .............................................................................................................................. 3195
RXMaximum ......................................................................................................................... 3196
RXMaximumType .................................................................................................................. 3196
RXMinimum ......................................................................................................................... 3196
RXMinimumType .................................................................................................................. 3196
RYMaximum ......................................................................................................................... 3196
RYMaximumType .................................................................................................................. 3196
RYMinimum .......................................................................................................................... 3197
RYMinimumType .................................................................................................................. 3197
RZMaximum ......................................................................................................................... 3197
RZMaximumType .................................................................................................................. 3197
RZMinimum .......................................................................................................................... 3197
RZMinimumType .................................................................................................................. 3197
ScrewPitch ............................................................................................................................ 3198
SolverElementType ............................................................................................................... 3198
Suppressed ........................................................................................................................... 3198
SuppressedForSolve ............................................................................................................. 3198
TorsionalDamping ................................................................................................................ 3198
TorsionalStiffness .................................................................................................................. 3198
TranslationX .......................................................................................................................... 3199
TranslationY .......................................................................................................................... 3199
TranslationZ .......................................................................................................................... 3199
Type ..................................................................................................................................... 3199
XMaximum ........................................................................................................................... 3199
XMaximumType .................................................................................................................... 3199
XMinimum ........................................................................................................................... 3200

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

XMinimumType .................................................................................................................... 3200

YMaximum ........................................................................................................................... 3200
YMaximumType .................................................................................................................... 3200
YMinimum ............................................................................................................................ 3200
YMinimumType .................................................................................................................... 3200
ZMaximum ........................................................................................................................... 3201
ZMaximumType .................................................................................................................... 3201
ZMinimum ............................................................................................................................ 3201
ZMinimumType .................................................................................................................... 3201
AddCommandSnippet() ........................................................................................................ 3201
AddComment() ..................................................................................................................... 3201
AddFigure() .......................................................................................................................... 3202
AddImage(string) .................................................................................................................. 3202
Delete() ................................................................................................................................ 3202
FlipReferenceMobile() ........................................................................................................... 3202
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3202
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3203
PromoteToNamedSelection() ................................................................................................ 3203
PromoteToRemotePoint() ...................................................................................................... 3203
RenameBasedOnDefinition() ................................................................................................. 3204
SpotWeldConnection .................................................................................................................. 3204
AngleTolerance ..................................................................................................................... 3205
Children ............................................................................................................................... 3205
Comments ............................................................................................................................ 3205
ConnectionBehavior ............................................................................................................. 3205
DataModelObjectCategory ................................................................................................... 3205
Images ................................................................................................................................. 3206
InternalObject ...................................................................................................................... 3206
Material ................................................................................................................................ 3206
NumberOfLayers ................................................................................................................... 3206
NumWeldPoints .................................................................................................................... 3206
PenetrationTolerance ............................................................................................................ 3206
Radius .................................................................................................................................. 3207
SearchDistance ..................................................................................................................... 3207
ShellThicknessEffect ............................................................................................................. 3207
SnapToEdgeTolerance ........................................................................................................... 3207
SourceGeometry ................................................................................................................... 3207
StiffnessBehavior .................................................................................................................. 3207
TargetGeometry ................................................................................................................... 3208
Type ..................................................................................................................................... 3208
AddComment() ..................................................................................................................... 3208
AddImage(string) .................................................................................................................. 3208
AddNewSpotWeld(int) .......................................................................................................... 3208
CreateSpotWeldFromHitPoint() ............................................................................................. 3209
ExportToCSVFile(string) ......................................................................................................... 3209
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3209
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3210
RemoveSpotWeld(int) ........................................................................................................... 3210
SetXCoordinate(int, Quantity) ................................................................................................ 3210
SetYCoordinate(int, Quantity) ................................................................................................ 3211
SetZCoordinate(int, Quantity) ................................................................................................ 3211

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

SpotWeldGroup .......................................................................................................................... 3211

AngleTolerance ..................................................................................................................... 3213
Children ............................................................................................................................... 3213
ChildrenCreationMethod ...................................................................................................... 3213
Comments ............................................................................................................................ 3213
ConnectionBehavior ............................................................................................................. 3213
DataModelObjectCategory ................................................................................................... 3213
Images ................................................................................................................................. 3214
InternalObject ...................................................................................................................... 3214
Material ................................................................................................................................ 3214
NumberOfLayers ................................................................................................................... 3214
NumConnections .................................................................................................................. 3214
NumWeldPoints .................................................................................................................... 3214
PenetrationTolerance ............................................................................................................ 3215
ShellThicknessEffect ............................................................................................................. 3215
SnapToEdgeTolerance ........................................................................................................... 3215
SpotWeldFileName ............................................................................................................... 3215
StiffnessBehavior .................................................................................................................. 3215
Units .................................................................................................................................... 3215
WeldRadius .......................................................................................................................... 3216
WeldSearchDistance ............................................................................................................. 3216
WeldType ............................................................................................................................. 3216
AddComment() ..................................................................................................................... 3216
AddImage(string) .................................................................................................................. 3216
AddSpotWeldConnection() ................................................................................................... 3217
ExportToFile(string) ............................................................................................................... 3217
GenerateSpotWeldConnections() .......................................................................................... 3217
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3217
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3218
Spring ........................................................................................................................................ 3218
Children ............................................................................................................................... 3220
Comments ............................................................................................................................ 3220
DataModelObjectCategory ................................................................................................... 3220
Figures ................................................................................................................................. 3220
FreeLength ........................................................................................................................... 3221
Images ................................................................................................................................. 3221
InternalObject ...................................................................................................................... 3221
Load ..................................................................................................................................... 3221
LongitudinalDamping ........................................................................................................... 3221
LongitudinalStiffness ............................................................................................................ 3221
Material ................................................................................................................................ 3222
MobileAppliedBy .................................................................................................................. 3222
MobileBeamMaterial ............................................................................................................. 3222
MobileBeamRadius ............................................................................................................... 3222
MobileBehavior .................................................................................................................... 3222
MobileBody .......................................................................................................................... 3222
MobileCoordinateSystem ...................................................................................................... 3223
MobileLocation ..................................................................................................................... 3223
MobilePinballRegion ............................................................................................................. 3223
MobileScopeLocation ........................................................................................................... 3223
MobileXCoordinate ............................................................................................................... 3223

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

MobileYCoordinate ............................................................................................................... 3223

MobileZCoordinate ............................................................................................................... 3224
NonLinearLongitudinalStiffness ............................................................................................ 3224
PreloadType ......................................................................................................................... 3224
ReferenceAppliedBy ............................................................................................................. 3224
ReferenceBeamMaterial ........................................................................................................ 3224
ReferenceBeamRadius .......................................................................................................... 3224
ReferenceBehavior ................................................................................................................ 3225
ReferenceBody ..................................................................................................................... 3225
ReferenceCoordinateSystem ................................................................................................. 3225
ReferenceLocation ................................................................................................................ 3225
ReferencePinballRegion ........................................................................................................ 3225
ReferenceScopeLocation ....................................................................................................... 3225
ReferenceXCoordinate .......................................................................................................... 3226
ReferenceYCoordinate .......................................................................................................... 3226
ReferenceZCoordinate .......................................................................................................... 3226
Rotation ............................................................................................................................... 3226
Scope ................................................................................................................................... 3226
SpringBehavior ..................................................................................................................... 3226
SpringElementAPDLName .................................................................................................... 3227
SpringLength ........................................................................................................................ 3227
SpringType ........................................................................................................................... 3227
Suppressed ........................................................................................................................... 3227
Torque .................................................................................................................................. 3227
TorsionalDamping ................................................................................................................ 3227
TorsionalStiffness .................................................................................................................. 3228
Visible .................................................................................................................................. 3228
AddCommandSnippet() ........................................................................................................ 3228
AddComment() ..................................................................................................................... 3228
AddFigure() .......................................................................................................................... 3228
AddImage(string) .................................................................................................................. 3228
Delete() ................................................................................................................................ 3229
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3229
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3229
PromoteToNamedSelection() ................................................................................................ 3230
PromoteToRemotePoint() ...................................................................................................... 3230
RenameBasedOnDefinition() ................................................................................................. 3230
Ansys.ACT.Automation.Mechanical.BoundaryConditions Namespace ......................................... 3231
Acceleration ............................................................................................................................... 3234
AbsoluteResult ..................................................................................................................... 3235
BaseExcitation ...................................................................................................................... 3235
BoundaryCondition .............................................................................................................. 3235
Children ............................................................................................................................... 3235
Comments ............................................................................................................................ 3236
CoordinateSystem ................................................................................................................ 3236
DataModelObjectCategory ................................................................................................... 3236
DefineBy ............................................................................................................................... 3236
Direction .............................................................................................................................. 3236
Figures ................................................................................................................................. 3236
Images ................................................................................................................................. 3237
IndependentVariable ............................................................................................................ 3237

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

InternalObject ...................................................................................................................... 3237

Location ............................................................................................................................... 3237
Magnitude ............................................................................................................................ 3237
MagnitudeImag .................................................................................................................... 3237
NumberOfSegments ............................................................................................................. 3238
PhaseAngle .......................................................................................................................... 3238
RpmSelection ....................................................................................................................... 3238
StepSelection ....................................................................................................................... 3238
StepVarying .......................................................................................................................... 3238
Suppressed ........................................................................................................................... 3238
XComponent ........................................................................................................................ 3239
YComponent ........................................................................................................................ 3239
ZComponent ........................................................................................................................ 3239
AddComment() ..................................................................................................................... 3239
AddFigure() .......................................................................................................................... 3239
AddImage(string) .................................................................................................................. 3239
Delete() ................................................................................................................................ 3240
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3240
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3240
AcousticAbsorptionElement ........................................................................................................ 3241
DataModelObjectCategory ................................................................................................... 3242
InternalObject ...................................................................................................................... 3242
Location ............................................................................................................................... 3242
AcousticAbsorptionSurface ......................................................................................................... 3242
AbsorptionCoefficient ........................................................................................................... 3243
DataModelObjectCategory ................................................................................................... 3243
InternalObject ...................................................................................................................... 3243
Location ............................................................................................................................... 3243
AcousticDiffuseSoundField ......................................................................................................... 3244
CoordinateSystem ................................................................................................................ 3245
DataModelObjectCategory ................................................................................................... 3245
FrequencyOfNormConvergenceCheck .................................................................................. 3245
InternalObject ...................................................................................................................... 3246
Location ............................................................................................................................... 3246
MassDensity ......................................................................................................................... 3246
Material ................................................................................................................................ 3246
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead ..................................... 3246
MaximumIncidentAngle ....................................................................................................... 3246
NormConvergenceTolerance ................................................................................................. 3247
NumberOfDivisionsOnReferenceSphere ................................................................................ 3247
NumberOfRandomSampling ................................................................................................. 3247
PressureExcitation ................................................................................................................. 3247
RadiusOfReferenceSphere ..................................................................................................... 3247
RadiusOfReferenceSphereDefineBy ....................................................................................... 3247
RandomSamplingType .......................................................................................................... 3248
ReferencePowerSpectralDensity ............................................................................................ 3248
SpeedOfSound ..................................................................................................................... 3248
AcousticFarFieldRadationSurface ................................................................................................ 3248
DataModelObjectCategory ................................................................................................... 3249
EquivalentSurfaceLocation .................................................................................................... 3249
InsideSurfaceBodiesLocation ................................................................................................ 3249

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

InternalObject ...................................................................................................................... 3249

AcousticFreeSurface ................................................................................................................... 3250
DataModelObjectCategory ................................................................................................... 3250
InternalObject ...................................................................................................................... 3251
Location ............................................................................................................................... 3251
AcousticImpedanceBoundary ..................................................................................................... 3251
DataModelObjectCategory ................................................................................................... 3252
Frequency ............................................................................................................................ 3252
InternalObject ...................................................................................................................... 3252
Location ............................................................................................................................... 3252
Reactance ............................................................................................................................. 3252
Resistance ............................................................................................................................ 3253
AcousticImpedanceSheet ........................................................................................................... 3253
DataModelObjectCategory ................................................................................................... 3254
InternalObject ...................................................................................................................... 3254
Location ............................................................................................................................... 3254
Reactance ............................................................................................................................. 3254
Resistance ............................................................................................................................ 3254
AcousticIncidentWaveSource ...................................................................................................... 3255
AnglePhi ............................................................................................................................... 3256
AngleTheta ........................................................................................................................... 3256
CalculateIncidentPower ........................................................................................................ 3256
DataModelObjectCategory ................................................................................................... 3257
DipoleLength ....................................................................................................................... 3257
ExcitationType ...................................................................................................................... 3257
IncidentWaveLocation .......................................................................................................... 3257
InternalObject ...................................................................................................................... 3257
MassDensity ......................................................................................................................... 3257
Material ................................................................................................................................ 3258
MaterialAssignment ***OBSOLETE*** Use 'Material' property instead ..................................... 3258
PhaseAngle .......................................................................................................................... 3258
PortSelection ........................................................................................................................ 3258
PressureAmplitude ............................................................................................................... 3258
RadiusOfPulsatingSphere ...................................................................................................... 3258
SourceOriginX ...................................................................................................................... 3259
SourceOriginY ...................................................................................................................... 3259
SourceOriginZ ...................................................................................................................... 3259
SpeedOfSound ..................................................................................................................... 3259
VelocityAmplitude ................................................................................................................ 3259
WaveNumber ........................................................................................................................ 3259
WaveType ............................................................................................................................. 3260
XComponentOfUnitDipoleVector .......................................................................................... 3260
YComponentOfUnitDipoleVector .......................................................................................... 3260
ZComponentOfUnitDipoleVector .......................................................................................... 3260
AcousticLowReducedFrequency .................................................................................................. 3260
DataModelObjectCategory ................................................................................................... 3261
HeightOfRectangle ............................................................................................................... 3261
InternalObject ...................................................................................................................... 3262
Location ............................................................................................................................... 3262
LowReducedFrequencyModel ............................................................................................... 3262
RadiusOfCircle ...................................................................................................................... 3262

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

ThicknessOfLayer .................................................................................................................. 3262

WidthOfRectangle ................................................................................................................ 3262
AcousticMassSource ................................................................................................................... 3263
DataModelObjectCategory ................................................................................................... 3263
InternalObject ...................................................................................................................... 3264
Location ............................................................................................................................... 3264
Magnitude ............................................................................................................................ 3264
PhaseAngle .......................................................................................................................... 3264
AcousticMassSourceRate ............................................................................................................ 3264
DataModelObjectCategory ................................................................................................... 3265
InternalObject ...................................................................................................................... 3265
Location ............................................................................................................................... 3266
Magnitude ............................................................................................................................ 3266
AcousticPort ............................................................................................................................... 3266
DataModelObjectCategory ................................................................................................... 3267
InsideSurfaceBodiesLocation ................................................................................................ 3267
InternalObject ...................................................................................................................... 3267
PortBehavior ......................................................................................................................... 3267
PortNumber ......................................................................................................................... 3268
PortPosition .......................................................................................................................... 3268
PortSurfaceLocation ............................................................................................................. 3268
AcousticPortInDuct ..................................................................................................................... 3268
AnglePhi ............................................................................................................................... 3269
AngleTheta ........................................................................................................................... 3270
CoordinateSystem ................................................................................................................ 3270
DataModelObjectCategory ................................................................................................... 3270
Height .................................................................................................................................. 3270
InternalObject ...................................................................................................................... 3270
Location ............................................................................................................................... 3270
ModeIndexForPressureVariationAlongTheAzimuth ................................................................ 3271
ModeIndexForPressureVariationAlongTheHeight .................................................................. 3271
ModeIndexForPressureVariationAlongTheRadii ..................................................................... 3271
ModeIndexForPressureVariationAlongTheWidth .................................................................... 3271
PhaseAngle .......................................................................................................................... 3271
PortAttribution ..................................................................................................................... 3271
PortSelection ........................................................................................................................ 3272
PressureAmplitude ............................................................................................................... 3272
Radius .................................................................................................................................. 3272
WaveType ............................................................................................................................. 3272
Width ................................................................................................................................... 3272
AcousticPressure ......................................................................................................................... 3272
DataModelObjectCategory ................................................................................................... 3273
InternalObject ...................................................................................................................... 3273
Location ............................................................................................................................... 3274
Magnitude ............................................................................................................................ 3274
AcousticRadiationBoundary ........................................................................................................ 3274
DataModelObjectCategory ................................................................................................... 3275
InternalObject ...................................................................................................................... 3275
Location ............................................................................................................................... 3275
AcousticRigidWall ....................................................................................................................... 3275
DataModelObjectCategory ................................................................................................... 3276

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

InternalObject ...................................................................................................................... 3276

Location ............................................................................................................................... 3276
AcousticStaticPressure ................................................................................................................ 3277
DataModelObjectCategory ................................................................................................... 3277
InternalObject ...................................................................................................................... 3278
Location ............................................................................................................................... 3278
Magnitude ............................................................................................................................ 3278
AcousticSurfaceAcceleration ....................................................................................................... 3278
DataModelObjectCategory ................................................................................................... 3279
DefineBy ............................................................................................................................... 3279
InternalObject ...................................................................................................................... 3279
Location ............................................................................................................................... 3280
Magnitude ............................................................................................................................ 3280
XComponent ........................................................................................................................ 3280
YComponent ........................................................................................................................ 3280
ZComponent ........................................................................................................................ 3280
AcousticSurfaceVelocity .............................................................................................................. 3280
DataModelObjectCategory ................................................................................................... 3281
DefineBy ............................................................................................................................... 3282
InternalObject ...................................................................................................................... 3282
Location ............................................................................................................................... 3282
Magnitude ............................................................................................................................ 3282
PhaseAngle .......................................................................................................................... 3282
XComponent ........................................................................................................................ 3282
XPhaseAngle ........................................................................................................................ 3283
YComponent ........................................................................................................................ 3283
YPhaseAngle ........................................................................................................................ 3283
ZComponent ........................................................................................................................ 3283
ZPhaseAngle ........................................................................................................................ 3283
AcousticSymmetryPlane ............................................................................................................. 3283
CoordinateSystem ................................................................................................................ 3284
DataModelObjectCategory ................................................................................................... 3284
InternalObject ...................................................................................................................... 3285
Location ............................................................................................................................... 3285
AcousticTemperature .................................................................................................................. 3285
DataModelObjectCategory ................................................................................................... 3286
InternalObject ...................................................................................................................... 3287
AcousticThermoViscousBLIBoundary .......................................................................................... 3287
DataModelObjectCategory ................................................................................................... 3288
InternalObject ...................................................................................................................... 3288
Location ............................................................................................................................... 3288
AcousticTransferAdmittanceMatrix .............................................................................................. 3288
Alpha1Imag .......................................................................................................................... 3289
Alpha1Real ........................................................................................................................... 3290
Alpha2Imag .......................................................................................................................... 3290
Alpha2Real ........................................................................................................................... 3290
DataModelObjectCategory ................................................................................................... 3290
DynamicViscosity ................................................................................................................. 3290
GridPeriod ............................................................................................................................ 3290
HoleRadius ........................................................................................................................... 3291
InternalObject ...................................................................................................................... 3291

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

MassDensity ......................................................................................................................... 3291

Port1 .................................................................................................................................... 3291
Port2 .................................................................................................................................... 3291
RatioOfInnerAndOuterRadius ................................................................................................ 3291
StructureThickness ............................................................................................................... 3292
TransferAdmittanceModel ..................................................................................................... 3292
Y11Imag ............................................................................................................................... 3292
Y11Real ................................................................................................................................ 3292
Y12Imag ............................................................................................................................... 3292
Y12Real ................................................................................................................................ 3292
Y21Imag ............................................................................................................................... 3293
Y21Real ................................................................................................................................ 3293
Y22Imag ............................................................................................................................... 3293
Y22Real ................................................................................................................................ 3293
BearingLoad ............................................................................................................................... 3293
CoordinateSystem ................................................................................................................ 3294
DataModelObjectCategory ................................................................................................... 3295
DefineBy ............................................................................................................................... 3295
Direction .............................................................................................................................. 3295
InternalObject ...................................................................................................................... 3295
Location ............................................................................................................................... 3295
Magnitude ............................................................................................................................ 3295
XComponent ........................................................................................................................ 3296
YComponent ........................................................................................................................ 3296
ZComponent ........................................................................................................................ 3296
GetActivateAtLoadStep(uint) ................................................................................................ 3296
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3296
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3297
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3297
BodyControl ............................................................................................................................... 3298
ArtificialViscosityForShells ..................................................................................................... 3299
BeamSolutionType ................................................................................................................ 3299
BeamTimeStepSafetyFactor .................................................................................................. 3299
DataModelObjectCategory ................................................................................................... 3299
HexIntegrationType .............................................................................................................. 3299
HourglassDampingType ........................................................................................................ 3300
InternalObject ...................................................................................................................... 3300
Location ............................................................................................................................... 3300
PusoStabilityCoefficient ........................................................................................................ 3300
ShellBWCWarpCorrection ...................................................................................................... 3300
ShellInertiaUpdate ................................................................................................................ 3300
ShellShearCorrectionFactor ................................................................................................... 3301
ShellSublayers ...................................................................................................................... 3301
ShellThicknessUpdate ........................................................................................................... 3301
StiffnessCoefficient ............................................................................................................... 3301
TetIntegrationType ............................................................................................................... 3301
ViscousCoefficient ................................................................................................................ 3301
BoltPretension ............................................................................................................................ 3302
Children ............................................................................................................................... 3303
Comments ............................................................................................................................ 3303
CoordinateSystem ................................................................................................................ 3303

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

CoordinateSystemBehavior ................................................................................................... 3303

DataModelObjectCategory ................................................................................................... 3303
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. .................................................................. 3304
Figures ................................................................................................................................. 3304
Formulation .......................................................................................................................... 3304
Images ................................................................................................................................. 3304
Increment ............................................................................................................................. 3304
InternalObject ...................................................................................................................... 3305
Location ............................................................................................................................... 3305
Preadjustment ...................................................................................................................... 3305
Preload ................................................................................................................................. 3305
SolveBehaviourType ............................................................................................................. 3305
Suppressed ........................................................................................................................... 3305
Tolerance .............................................................................................................................. 3306
AddComment() ..................................................................................................................... 3306
AddFigure() .......................................................................................................................... 3306
AddImage(string) .................................................................................................................. 3306
Delete() ................................................................................................................................ 3306
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3307
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3307
GetDefineBy(int) ................................................................................................................... 3307
PromoteToCoordinateSystem() .............................................................................................. 3308
PromoteToNamedSelection() ................................................................................................ 3308
SetDefineBy(int, BoltLoadDefineBy) ....................................................................................... 3308
CompressionOnlySupport ........................................................................................................... 3308
AutomaticNormalStiffness .................................................................................................... 3309
DataModelObjectCategory ................................................................................................... 3310
InternalObject ...................................................................................................................... 3310
Location ............................................................................................................................... 3310
NormalStiffnessFactor ........................................................................................................... 3310
UpdateStiffness .................................................................................................................... 3310
ConstraintEquation ..................................................................................................................... 3310
Children ............................................................................................................................... 3311
Comments ............................................................................................................................ 3311
DataModelObjectCategory ................................................................................................... 3311
Figures ................................................................................................................................. 3312
InternalObject ...................................................................................................................... 3312
Suppressed ........................................................................................................................... 3312
AddCommandSnippet() ........................................................................................................ 3312
AddComment() ..................................................................................................................... 3312
AddFigure() .......................................................................................................................... 3312
Delete() ................................................................................................................................ 3313
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3313
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3313
ContactStepControl .................................................................................................................... 3314
ContactSelection .................................................................................................................. 3314
CurrentStep .......................................................................................................................... 3314
DataModelObjectCategory ................................................................................................... 3315
InternalObject ...................................................................................................................... 3315

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

NormalStiffness .................................................................................................................... 3315

NormalStiffnessFactor ........................................................................................................... 3315
NormalStiffnessValue ............................................................................................................ 3315
Status ................................................................................................................................... 3315
Convection ................................................................................................................................. 3316
AmbientTemperature ............................................................................................................ 3317
CoefficientType ..................................................................................................................... 3317
ConvectionMatrix ................................................................................................................. 3317
DataModelObjectCategory ................................................................................................... 3318
DisplayConnectionLines ........................................................................................................ 3318
EditDataFor .......................................................................................................................... 3318
FilmCoefficient ..................................................................................................................... 3318
FluidFlowEdge ***OBSOLETE*** Deprecated class. Use FluidFlowSelection instead. ................ 3318
FluidFlowSelection ............................................................................................................... 3318
GraphControlsXAxis .............................................................................................................. 3319
HasFluidFlow ........................................................................................................................ 3319
IndependentVariable ............................................................................................................ 3319
InternalObject ...................................................................................................................... 3319
Location ............................................................................................................................... 3319
NumberOfSegments ............................................................................................................. 3319
RangeMaximum ................................................................................................................... 3320
RangeMinimum .................................................................................................................... 3320
XYZFunctionCoordinateSystem ............................................................................................. 3320
GetActivateAtLoadStep(uint) ................................................................................................ 3320
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3320
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3321
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3321
CoupledPhysicsHeatingObjects ................................................................................................... 3322
Children ............................................................................................................................... 3322
Comments ............................................................................................................................ 3322
DataModelObjectCategory ................................................................................................... 3323
Images ................................................................................................................................. 3323
InternalObject ...................................................................................................................... 3323
Location ............................................................................................................................... 3323
Suppressed ........................................................................................................................... 3323
AddComment() ..................................................................................................................... 3323
AddImage(string) .................................................................................................................. 3324
Delete() ................................................................................................................................ 3324
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3324
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3324
Coupling .................................................................................................................................... 3325
Children ............................................................................................................................... 3326
Comments ............................................................................................................................ 3326
DataModelObjectCategory ................................................................................................... 3326
DOFSelection ....................................................................................................................... 3326
Images ................................................................................................................................. 3326
InternalObject ...................................................................................................................... 3326
LocalCoordinates .................................................................................................................. 3327
Location ............................................................................................................................... 3327
Suppressed ........................................................................................................................... 3327
AddComment() ..................................................................................................................... 3327

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

AddImage(string) .................................................................................................................. 3327

Delete() ................................................................................................................................ 3328
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3328
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3328
Current ....................................................................................................................................... 3329
DataModelObjectCategory ................................................................................................... 3330
InternalObject ...................................................................................................................... 3330
Location ............................................................................................................................... 3330
Magnitude ............................................................................................................................ 3330
NumberOfSegments ............................................................................................................. 3330
PhaseAngle .......................................................................................................................... 3331
GetActivateAtLoadStep(uint) ................................................................................................ 3331
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3331
CylindricalSupport ...................................................................................................................... 3331
Axial ..................................................................................................................................... 3332
DataModelObjectCategory ................................................................................................... 3333
InternalObject ...................................................................................................................... 3333
Location ............................................................................................................................... 3333
Radial ................................................................................................................................... 3333
Tangential ............................................................................................................................ 3333
DetonationPoint ......................................................................................................................... 3333
BurnInstantaneously ............................................................................................................. 3334
DataModelObjectCategory ................................................................................................... 3335
DetonationTime ................................................................................................................... 3335
InternalObject ...................................................................................................................... 3335
Location ............................................................................................................................... 3335
XCoordinate ......................................................................................................................... 3335
YCoordinate .......................................................................................................................... 3335
ZCoordinate ......................................................................................................................... 3336
Displacement ............................................................................................................................. 3336
AbsoluteResult ..................................................................................................................... 3337
BaseExcitation ...................................................................................................................... 3338
BoundaryCondition .............................................................................................................. 3338
CoordinateSystem ................................................................................................................ 3338
DataModelObjectCategory ................................................................................................... 3338
DefineBy ............................................................................................................................... 3338
Direction .............................................................................................................................. 3338
Distance ............................................................................................................................... 3339
DynamicRelaxationBehavior ................................................................................................. 3339
GraphControlsXAxis .............................................................................................................. 3339
IndependentVariable ............................................................................................................ 3339
InternalObject ...................................................................................................................... 3339
LoadStepVarying .................................................................................................................. 3339
Location ............................................................................................................................... 3340
MagnitudeImag .................................................................................................................... 3340
NumberOfSegments ............................................................................................................. 3340
PhaseAngle .......................................................................................................................... 3340
RangeMaximum ................................................................................................................... 3340
RangeMinimum .................................................................................................................... 3340
ReverseDirectionForInverseSteps .......................................................................................... 3341
RpmSelection ....................................................................................................................... 3341

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

StepSelection ....................................................................................................................... 3341

XComponent ........................................................................................................................ 3341
XComponentImag ................................................................................................................ 3341
XPhaseAngle ........................................................................................................................ 3341
XYZFunctionCoordinateSystem ............................................................................................. 3342
YComponent ........................................................................................................................ 3342
YComponentImag ................................................................................................................ 3342
YPhaseAngle ........................................................................................................................ 3342
ZComponent ........................................................................................................................ 3342
ZComponentImag ................................................................................................................ 3342
ZPhaseAngle ........................................................................................................................ 3343
GetActivateAtLoadStep(uint) ................................................................................................ 3343
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3343
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3343
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3344
EarthGravity ............................................................................................................................... 3344
Children ............................................................................................................................... 3345
Comments ............................................................................................................................ 3345
CoordinateSystem ................................................................................................................ 3345
DataModelObjectCategory ................................................................................................... 3346
Direction .............................................................................................................................. 3346
Figures ................................................................................................................................. 3346
GeometrySelection ............................................................................................................... 3346
Images ................................................................................................................................. 3346
InternalObject ...................................................................................................................... 3346
Suppressed ........................................................................................................................... 3347
XComponent ........................................................................................................................ 3347
YComponent ........................................................................................................................ 3347
ZComponent ........................................................................................................................ 3347
AddComment() ..................................................................................................................... 3347
AddFigure() .......................................................................................................................... 3347
AddImage(string) .................................................................................................................. 3348
Delete() ................................................................................................................................ 3348
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3348
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3349
ElasticSupport ............................................................................................................................ 3349
DataModelObjectCategory ................................................................................................... 3350
FoundationStiffness .............................................................................................................. 3350
InternalObject ...................................................................................................................... 3350
Location ............................................................................................................................... 3350
ElectricCharge ............................................................................................................................ 3351
DataModelObjectCategory ................................................................................................... 3351
InternalObject ...................................................................................................................... 3352
Location ............................................................................................................................... 3352
Magnitude ............................................................................................................................ 3352
VoltageCoupling ................................................................................................................... 3352
ElementBirthAndDeath ............................................................................................................... 3352
CurrentStep .......................................................................................................................... 3353
DataModelObjectCategory ................................................................................................... 3353
InternalObject ...................................................................................................................... 3353
Location ............................................................................................................................... 3353

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

Status ................................................................................................................................... 3354

ElementControls ......................................................................................................................... 3354
Children ............................................................................................................................... 3354
Comments ............................................................................................................................ 3355
DataModelObjectCategory ................................................................................................... 3355
Figures ................................................................................................................................. 3355
Images ................................................................................................................................. 3355
InternalObject ...................................................................................................................... 3355
Suppressed ........................................................................................................................... 3355
AddComment() ..................................................................................................................... 3356
AddFigure() .......................................................................................................................... 3356
AddImage(string) .................................................................................................................. 3356
Delete() ................................................................................................................................ 3356
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3356
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3357
EMTransducer ............................................................................................................................. 3357
CoordinateSystem ................................................................................................................ 3358
DataModelObjectCategory ................................................................................................... 3359
GAPDirection ........................................................................................................................ 3359
IndependentVariable ............................................................................................................ 3359
InitialGap .............................................................................................................................. 3359
InternalObject ...................................................................................................................... 3359
Location ............................................................................................................................... 3359
MinimalGap .......................................................................................................................... 3360
NumberOfSegments ............................................................................................................. 3360
StiffnessMethod ................................................................................................................... 3360
VoltageDifference ................................................................................................................. 3360
ZCoordinate ......................................................................................................................... 3360
GetActivateAtLoadStep(uint) ................................................................................................ 3360
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3361
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3361
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3361
FixedRotation ............................................................................................................................. 3362
CoordinateSystem ................................................................................................................ 3363
DataModelObjectCategory ................................................................................................... 3363
InternalObject ...................................................................................................................... 3363
Location ............................................................................................................................... 3363
RotationX ............................................................................................................................. 3364
RotationY ............................................................................................................................. 3364
RotationZ ............................................................................................................................. 3364
FixedSupport .............................................................................................................................. 3364
DataModelObjectCategory ................................................................................................... 3365
InternalObject ...................................................................................................................... 3365
Location ............................................................................................................................... 3365
FluidSolidInterface ...................................................................................................................... 3365
DataModelObjectCategory ................................................................................................... 3366
ExportResults ....................................................................................................................... 3366
InterfaceNumber .................................................................................................................. 3367
InternalObject ...................................................................................................................... 3367
Location ............................................................................................................................... 3367
Force .......................................................................................................................................... 3367

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

AppliedBy ............................................................................................................................. 3369

CoordinateSystem ................................................................................................................ 3369
DataModelObjectCategory ................................................................................................... 3369
DefineBy ............................................................................................................................... 3369
Direction .............................................................................................................................. 3370
DivideLoadByNodes .............................................................................................................. 3370
DynamicRelaxationBehavior ................................................................................................. 3370
GraphControlsXAxis .............................................................................................................. 3370
HarmonicIndex ..................................................................................................................... 3370
IndependentVariable ............................................................................................................ 3370
InternalObject ...................................................................................................................... 3371
LoadStepVarying .................................................................................................................. 3371
Location ............................................................................................................................... 3371
Magnitude ............................................................................................................................ 3371
MagnitudeImag .................................................................................................................... 3371
NonCyclicLoadingType ......................................................................................................... 3371
NumberOfSegments ............................................................................................................. 3372
PhaseAngle .......................................................................................................................... 3372
RangeMaximum ................................................................................................................... 3372
RangeMinimum .................................................................................................................... 3372
RpmSelection ....................................................................................................................... 3372
SectorNumber ...................................................................................................................... 3372
StepSelection ....................................................................................................................... 3373
XComponent ........................................................................................................................ 3373
XComponentImag ................................................................................................................ 3373
XPhaseAngle ........................................................................................................................ 3373
YComponent ........................................................................................................................ 3373
YComponentImag ................................................................................................................ 3373
YPhaseAngle ........................................................................................................................ 3374
ZComponent ........................................................................................................................ 3374
ZComponentImag ................................................................................................................ 3374
ZPhaseAngle ........................................................................................................................ 3374
GetActivateAtLoadStep(uint) ................................................................................................ 3374
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3375
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3375
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3375
FrictionlessSupport ..................................................................................................................... 3376
DataModelObjectCategory ................................................................................................... 3377
InternalObject ...................................................................................................................... 3377
Location ............................................................................................................................... 3377
GeneralizedPlaneStrain ............................................................................................................... 3377
BoundaryConditionAlongFiber ............................................................................................. 3378
BoundaryConditionForRotationAboutX ................................................................................. 3378
BoundaryConditionForRotationAboutY ................................................................................. 3378
Children ............................................................................................................................... 3379
Comments ............................................................................................................................ 3379
CoordinateSystem ................................................................................................................ 3379
DataModelObjectCategory ................................................................................................... 3379
Figures ................................................................................................................................. 3379
Images ................................................................................................................................. 3379
InternalObject ...................................................................................................................... 3380

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

MagnitudeAlongFiber ........................................................................................................... 3380

MagnitudeRotationX ............................................................................................................ 3380
MagnitudeRotationY ............................................................................................................. 3380
Suppressed ........................................................................................................................... 3380
XCoordinateOfRefPoint ......................................................................................................... 3380
YCoordinateOfRefPoint ......................................................................................................... 3381
AddComment() ..................................................................................................................... 3381
AddFigure() .......................................................................................................................... 3381
AddImage(string) .................................................................................................................. 3381
Delete() ................................................................................................................................ 3381
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3382
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3382
GenericBoundaryCondition ........................................................................................................ 3382
Children ............................................................................................................................... 3383
Comments ............................................................................................................................ 3383
DataModelObjectCategory ................................................................................................... 3384
Figures ................................................................................................................................. 3384
Images ................................................................................................................................. 3384
InternalObject ...................................................................................................................... 3384
SharedRefBody ..................................................................................................................... 3384
Suppressed ........................................................................................................................... 3384
AddComment() ..................................................................................................................... 3385
AddFigure() .......................................................................................................................... 3385
AddImage(string) .................................................................................................................. 3385
Delete() ................................................................................................................................ 3385
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3385
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3386
PromoteToNamedSelection() ................................................................................................ 3386
HeatFlow .................................................................................................................................... 3386
DataModelObjectCategory ................................................................................................... 3387
DefineAs ............................................................................................................................... 3388
InternalObject ...................................................................................................................... 3388
Location ............................................................................................................................... 3388
Magnitude ............................................................................................................................ 3388
NumberOfSegments ............................................................................................................. 3388
GetActivateAtLoadStep(uint) ................................................................................................ 3388
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3389
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3389
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3389
HeatFlux ..................................................................................................................................... 3390
DataModelObjectCategory ................................................................................................... 3391
GraphControlsXAxis .............................................................................................................. 3391
IndependentVariable ............................................................................................................ 3391
InternalObject ...................................................................................................................... 3392
Location ............................................................................................................................... 3392
Magnitude ............................................................................................................................ 3392
NumberOfSegments ............................................................................................................. 3392
XYZFunctionCoordinateSystem ............................................................................................. 3392
GetActivateAtLoadStep(uint) ................................................................................................ 3392
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3393
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3393

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

SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3393

HydrostaticPressure .................................................................................................................... 3394
AppliedBy ............................................................................................................................. 3395
CoordinateSystem ................................................................................................................ 3395
DataModelObjectCategory ................................................................................................... 3395
DefineBy ............................................................................................................................... 3396
Direction .............................................................................................................................. 3396
FluidDensity ......................................................................................................................... 3396
InternalObject ...................................................................................................................... 3396
Location ............................................................................................................................... 3396
Magnitude ............................................................................................................................ 3396
ShellFace .............................................................................................................................. 3397
XComponent ........................................................................................................................ 3397
XCoordinate ......................................................................................................................... 3397
YComponent ........................................................................................................................ 3397
YCoordinate .......................................................................................................................... 3397
ZComponent ........................................................................................................................ 3397
ZCoordinate ......................................................................................................................... 3398
GetActivateAtLoadStep(uint) ................................................................................................ 3398
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3398
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3398
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3399
ImpedanceBoundary .................................................................................................................. 3399
DataModelObjectCategory ................................................................................................... 3400
InternalObject ...................................................................................................................... 3400
Location ............................................................................................................................... 3400
MaterialImpedance ............................................................................................................... 3401
ReferencePressure ................................................................................................................ 3401
ReferenceVelocity ................................................................................................................. 3401
ImportedCFDPressure ................................................................................................................. 3401
CFDPressureFile .................................................................................................................... 3402
DataModelObjectCategory ................................................................................................... 3402
InternalObject ...................................................................................................................... 3402
Location ............................................................................................................................... 3402
InternalHeatGeneration .............................................................................................................. 3403
DataModelObjectCategory ................................................................................................... 3404
InternalObject ...................................................................................................................... 3404
Location ............................................................................................................................... 3404
Magnitude ............................................................................................................................ 3404
NumberOfSegments ............................................................................................................. 3404
GetActivateAtLoadStep(uint) ................................................................................................ 3404
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3405
JointLoad ................................................................................................................................... 3405
Children ............................................................................................................................... 3406
Comments ............................................................................................................................ 3406
CutoffFrequency ................................................................................................................... 3406
DataModelObjectCategory ................................................................................................... 3407
DOF ...................................................................................................................................... 3407
Figures ................................................................................................................................. 3407
FittingMethod ...................................................................................................................... 3407
Images ................................................................................................................................. 3407

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

InternalObject ...................................................................................................................... 3407

Joint ..................................................................................................................................... 3408
JointConditionType .............................................................................................................. 3408
LockAtLoadStep .................................................................................................................... 3408
Magnitude ............................................................................................................................ 3408
NumberOfSegments ............................................................................................................. 3408
Suppressed ........................................................................................................................... 3408
AddCommandSnippet() ........................................................................................................ 3409
AddComment() ..................................................................................................................... 3409
AddFigure() .......................................................................................................................... 3409
AddImage(string) .................................................................................................................. 3409
Delete() ................................................................................................................................ 3409
GetActivateAtLoadStep(uint) ................................................................................................ 3410
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3410
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3410
RenameBasedOnDefinition() ................................................................................................. 3411
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3411
LegacyThermalCondition ............................................................................................................ 3411
Children ............................................................................................................................... 3412
Comments ............................................................................................................................ 3412
DataModelObjectCategory ................................................................................................... 3412
Figures ................................................................................................................................. 3412
Images ................................................................................................................................. 3413
InternalObject ...................................................................................................................... 3413
AddComment() ..................................................................................................................... 3413
AddFigure() .......................................................................................................................... 3413
AddImage(string) .................................................................................................................. 3413
Delete() ................................................................................................................................ 3414
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3414
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3414
LimitBoundary ............................................................................................................................ 3415
DataModelObjectCategory ................................................................................................... 3416
InternalObject ...................................................................................................................... 3416
LimitBCDirection .................................................................................................................. 3416
LimitBCMax .......................................................................................................................... 3416
LimitBCMaxX ........................................................................................................................ 3416
LimitBCMaxY ........................................................................................................................ 3416
LimitBCMaxZ ........................................................................................................................ 3417
LimitBCMin ........................................................................................................................... 3417
LimitBCMinX ......................................................................................................................... 3417
LimitBCMinY ......................................................................................................................... 3417
LimitBCMinZ ......................................................................................................................... 3417
Location ............................................................................................................................... 3417
LinePressure ............................................................................................................................... 3418
CoordinateSystem ................................................................................................................ 3419
DataModelObjectCategory ................................................................................................... 3419
DefineBy ............................................................................................................................... 3419
Direction .............................................................................................................................. 3419
GraphControlsXAxis .............................................................................................................. 3420
IndependentVariable ............................................................................................................ 3420
InternalObject ...................................................................................................................... 3420

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

Location ............................................................................................................................... 3420

Magnitude ............................................................................................................................ 3420
NumberOfSegments ............................................................................................................. 3420
PhaseAngle .......................................................................................................................... 3421
RangeMaximum ................................................................................................................... 3421
RangeMinimum .................................................................................................................... 3421
XComponent ........................................................................................................................ 3421
XYZFunctionCoordinateSystem ............................................................................................. 3421
YComponent ........................................................................................................................ 3421
ZComponent ........................................................................................................................ 3422
GetActivateAtLoadStep(uint) ................................................................................................ 3422
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3422
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3422
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3423
LoadGroup ................................................................................................................................. 3423
Children ............................................................................................................................... 3424
Comments ............................................................................................................................ 3425
ConductingArea ................................................................................................................... 3425
ConductorCurrent ................................................................................................................. 3425
ConductorType ..................................................................................................................... 3425
DataImportStatus ................................................................................................................. 3425
DataModelObjectCategory ................................................................................................... 3425
Figures ................................................................................................................................. 3426
Images ................................................................................................................................. 3426
ImportedDataType ................................................................................................................ 3426
InternalObject ...................................................................................................................... 3426
Location ............................................................................................................................... 3426
NumberOfFrequenciesToConsider ......................................................................................... 3426
NumberOfTurns .................................................................................................................... 3427
OnDataRefreshOption ........................................................................................................... 3427
PhaseAngle .......................................................................................................................... 3427
SolutionId ............................................................................................................................. 3427
Suppressed ........................................................................................................................... 3427
TransferFileName .................................................................................................................. 3427
UseInternalRemotePoints ...................................................................................................... 3428
AddComment() ..................................................................................................................... 3428
AddCurrent() ........................................................................................................................ 3428
AddFigure() .......................................................................................................................... 3428
AddImage(string) .................................................................................................................. 3428
AddVoltage() ........................................................................................................................ 3429
Delete() ................................................................................................................................ 3429
GenerateRemoteLoads() ....................................................................................................... 3429
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3429
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3429
MagneticFluxParallel ................................................................................................................... 3430
DataModelObjectCategory ................................................................................................... 3431
InternalObject ...................................................................................................................... 3431
Location ............................................................................................................................... 3431
MassFlowRate ............................................................................................................................. 3431
DataModelObjectCategory ................................................................................................... 3432
InternalObject ...................................................................................................................... 3432

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

Location ............................................................................................................................... 3432

Magnitude ............................................................................................................................ 3433
Moment ..................................................................................................................................... 3433
BeamMaterial ....................................................................................................................... 3434
BeamRadius .......................................................................................................................... 3435
Behavior ............................................................................................................................... 3435
CoordinateSystem ................................................................................................................ 3435
DataModelObjectCategory ................................................................................................... 3435
DefineBy ............................................................................................................................... 3435
Direction .............................................................................................................................. 3435
HarmonicIndex ..................................................................................................................... 3436
IndependentVariable ............................................................................................................ 3436
InternalObject ...................................................................................................................... 3436
LoadingApplicationType ....................................................................................................... 3436
LoadStepVarying .................................................................................................................. 3436
Location ............................................................................................................................... 3436
Magnitude ............................................................................................................................ 3437
MagnitudeImag .................................................................................................................... 3437
NonCyclicLoadingType ......................................................................................................... 3437
NumberOfSegments ............................................................................................................. 3437
PhaseAngle .......................................................................................................................... 3437
PinballRegion ....................................................................................................................... 3437
RemotePoint ......................................................................................................................... 3438
RpmSelection ....................................................................................................................... 3438
SectorNumber ...................................................................................................................... 3438
StepSelection ....................................................................................................................... 3438
XComponent ........................................................................................................................ 3438
XComponentImag ................................................................................................................ 3438
XPhaseAngle ........................................................................................................................ 3439
YComponent ........................................................................................................................ 3439
YComponentImag ................................................................................................................ 3439
YPhaseAngle ........................................................................................................................ 3439
ZComponent ........................................................................................................................ 3439
ZComponentImag ................................................................................................................ 3439
ZPhaseAngle ........................................................................................................................ 3440
GetActivateAtLoadStep(uint) ................................................................................................ 3440
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3440
PromoteToRemotePoint() ...................................................................................................... 3440
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3441
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3441
NodalDisplacement .................................................................................................................... 3441
CoordinateSystem ................................................................................................................ 3443
DataModelObjectCategory ................................................................................................... 3443
DynamicRelaxationBehavior ................................................................................................. 3443
GraphControlsXAxis .............................................................................................................. 3443
IndependentVariable ............................................................................................................ 3443
InternalObject ...................................................................................................................... 3444
Location ............................................................................................................................... 3444
NumberOfSegments ............................................................................................................. 3444
PhaseAngle .......................................................................................................................... 3444
RangeMaximum ................................................................................................................... 3444

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

RangeMinimum .................................................................................................................... 3444

ReverseDirectionForInverseSteps .......................................................................................... 3445
XComponent ........................................................................................................................ 3445
XYZFunctionCoordinateSystem ............................................................................................. 3445
YComponent ........................................................................................................................ 3445
ZComponent ........................................................................................................................ 3445
GetActivateAtLoadStep(uint) ................................................................................................ 3445
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3446
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3446
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3446
NodalForce ................................................................................................................................. 3447
CoordinateSystem ................................................................................................................ 3448
DataModelObjectCategory ................................................................................................... 3449
DivideLoadByNodes .............................................................................................................. 3449
DynamicRelaxationBehavior ................................................................................................. 3449
GraphControlsXAxis .............................................................................................................. 3449
HarmonicIndex ..................................................................................................................... 3449
IndependentVariable ............................................................................................................ 3449
InternalObject ...................................................................................................................... 3450
Location ............................................................................................................................... 3450
NonCyclicLoadingType ......................................................................................................... 3450
NumberOfSegments ............................................................................................................. 3450
PhaseAngle .......................................................................................................................... 3450
RangeMaximum ................................................................................................................... 3450
RangeMinimum .................................................................................................................... 3451
SectorNumber ...................................................................................................................... 3451
XComponent ........................................................................................................................ 3451
XYZFunctionCoordinateSystem ............................................................................................. 3451
YComponent ........................................................................................................................ 3451
ZComponent ........................................................................................................................ 3451
GetActivateAtLoadStep(uint) ................................................................................................ 3452
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3452
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3452
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3453
NodalOrientation ........................................................................................................................ 3453
Children ............................................................................................................................... 3454
Comments ............................................................................................................................ 3454
CoordinateSystem ................................................................................................................ 3454
DataModelObjectCategory ................................................................................................... 3454
Images ................................................................................................................................. 3454
InternalObject ...................................................................................................................... 3455
Location ............................................................................................................................... 3455
Suppressed ........................................................................................................................... 3455
AddComment() ..................................................................................................................... 3455
AddImage(string) .................................................................................................................. 3455
Delete() ................................................................................................................................ 3456
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3456
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3456
NodalPressure ............................................................................................................................ 3457
DataModelObjectCategory ................................................................................................... 3458
DefineBy ............................................................................................................................... 3458

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

GraphControlsXAxis .............................................................................................................. 3458

IndependentVariable ............................................................................................................ 3458
InternalObject ...................................................................................................................... 3458
Location ............................................................................................................................... 3459
Magnitude ............................................................................................................................ 3459
NumberOfSegments ............................................................................................................. 3459
RangeMaximum ................................................................................................................... 3459
RangeMinimum .................................................................................................................... 3459
XYZFunctionCoordinateSystem ............................................................................................. 3459
GetActivateAtLoadStep(uint) ................................................................................................ 3460
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3460
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3460
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3461
NodalRotation ............................................................................................................................ 3461
CoordinateSystem ................................................................................................................ 3462
DataModelObjectCategory ................................................................................................... 3462
InternalObject ...................................................................................................................... 3462
Location ............................................................................................................................... 3463
RotationX ............................................................................................................................. 3463
RotationY ............................................................................................................................. 3463
RotationZ ............................................................................................................................. 3463
NonlinearAdaptiveRegion ........................................................................................................... 3463
CheckAt ................................................................................................................................ 3464
CheckAtValue ....................................................................................................................... 3465
Children ............................................................................................................................... 3465
Comments ............................................................................................................................ 3465
CoordinateSystem ................................................................................................................ 3465
Criterion ............................................................................................................................... 3465
DataModelObjectCategory ................................................................................................... 3465
EndTime ............................................................................................................................... 3466
EnergyCoefficient ................................................................................................................. 3466
Figures ................................................................................................................................. 3466
HexDomCheckAt .................................................................................................................. 3466
HexDomCheckAtValue .......................................................................................................... 3466
HexDomEndTime ................................................................................................................. 3466
HexDomStartTime ................................................................................................................ 3467
HexDomTimeRange .............................................................................................................. 3467
Images ................................................................................................................................. 3467
InternalObject ...................................................................................................................... 3467
JacobianRatioValue ............................................................................................................... 3467
LengthX ............................................................................................................................... 3467
LengthY ................................................................................................................................ 3468
LengthZ ................................................................................................................................ 3468
Location ............................................................................................................................... 3468
MaximumCornerAngle .......................................................................................................... 3468
Option .................................................................................................................................. 3468
SkewnessValue ..................................................................................................................... 3468
StartTime .............................................................................................................................. 3469
Suppressed ........................................................................................................................... 3469
TimeRange ........................................................................................................................... 3469
AddComment() ..................................................................................................................... 3469

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

AddFigure() .......................................................................................................................... 3469

AddImage(string) .................................................................................................................. 3469
Delete() ................................................................................................................................ 3470
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3470
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3470
PerfectlyInsulated ....................................................................................................................... 3471
DataModelObjectCategory ................................................................................................... 3472
DefineAs ............................................................................................................................... 3472
InternalObject ...................................................................................................................... 3472
Location ............................................................................................................................... 3472
Magnitude ............................................................................................................................ 3472
PipePressure ............................................................................................................................... 3473
DataModelObjectCategory ................................................................................................... 3474
GraphControlsXAxis .............................................................................................................. 3474
IndependentVariable ............................................................................................................ 3474
InternalObject ...................................................................................................................... 3474
Loading ................................................................................................................................ 3474
Location ............................................................................................................................... 3475
Magnitude ............................................................................................................................ 3475
NumberOfSegments ............................................................................................................. 3475
PhaseAngle .......................................................................................................................... 3475
RangeMaximum ................................................................................................................... 3475
RangeMinimum .................................................................................................................... 3475
XYZFunctionCoordinateSystem ............................................................................................. 3476
GetActivateAtLoadStep(uint) ................................................................................................ 3476
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3476
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3476
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3477
PipeTemperature ........................................................................................................................ 3477
DataModelObjectCategory ................................................................................................... 3478
GraphControlsXAxis .............................................................................................................. 3479
IndependentVariable ............................................................................................................ 3479
InternalObject ...................................................................................................................... 3479
Loading ................................................................................................................................ 3479
Location ............................................................................................................................... 3479
Magnitude ............................................................................................................................ 3479
NumberOfSegments ............................................................................................................. 3480
RangeMaximum ................................................................................................................... 3480
RangeMinimum .................................................................................................................... 3480
XYZFunctionCoordinateSystem ............................................................................................. 3480
GetActivateAtLoadStep(uint) ................................................................................................ 3480
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3481
PlasticHeating ............................................................................................................................. 3481
DataModelObjectCategory ................................................................................................... 3482
InternalObject ...................................................................................................................... 3482
PlasticWorkFraction .............................................................................................................. 3482
Pressure ...................................................................................................................................... 3482
AppliedBy ............................................................................................................................. 3484
CoordinateSystem ................................................................................................................ 3484
DataModelObjectCategory ................................................................................................... 3484
DefineBy ............................................................................................................................... 3484

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

Direction .............................................................................................................................. 3484

DynamicRelaxationBehavior ................................................................................................. 3485
GraphControlsXAxis .............................................................................................................. 3485
HarmonicIndex ..................................................................................................................... 3485
IndependentVariable ............................................................................................................ 3485
InternalObject ...................................................................................................................... 3485
LoadedArea .......................................................................................................................... 3485
Location ............................................................................................................................... 3486
Magnitude ............................................................................................................................ 3486
MagnitudeImag .................................................................................................................... 3486
NonCyclicLoadingType ......................................................................................................... 3486
NumberOfSegments ............................................................................................................. 3486
PhaseAngle .......................................................................................................................... 3486
RangeMaximum ................................................................................................................... 3487
RangeMinimum .................................................................................................................... 3487
SectorNumber ...................................................................................................................... 3487
XComponent ........................................................................................................................ 3487
XComponentImag ................................................................................................................ 3487
XPhaseAngle ........................................................................................................................ 3487
XYZFunctionCoordinateSystem ............................................................................................. 3488
YComponent ........................................................................................................................ 3488
YComponentImag ................................................................................................................ 3488
YPhaseAngle ........................................................................................................................ 3488
ZComponent ........................................................................................................................ 3488
ZComponentImag ................................................................................................................ 3488
ZPhaseAngle ........................................................................................................................ 3489
GetActivateAtLoadStep(uint) ................................................................................................ 3489
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3489
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3489
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3490
PSDAcceleration ......................................................................................................................... 3490
DataModelObjectCategory ................................................................................................... 3491
InternalObject ...................................................................................................................... 3491
LoadData .............................................................................................................................. 3491
PSDDisplacement ....................................................................................................................... 3492
DataModelObjectCategory ................................................................................................... 3492
InternalObject ...................................................................................................................... 3492
LoadData .............................................................................................................................. 3493
PSDGAcceleration ....................................................................................................................... 3493
DataModelObjectCategory ................................................................................................... 3494
InternalObject ...................................................................................................................... 3494
LoadData .............................................................................................................................. 3494
PSDLoad ..................................................................................................................................... 3494
BoundaryCondition .............................................................................................................. 3495
Children ............................................................................................................................... 3495
Comments ............................................................................................................................ 3495
DataModelObjectCategory ................................................................................................... 3495
Direction .............................................................................................................................. 3495
Figures ................................................................................................................................. 3496
Images ................................................................................................................................. 3496
InternalObject ...................................................................................................................... 3496

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

Suppressed ........................................................................................................................... 3496

AddComment() ..................................................................................................................... 3496
AddFigure() .......................................................................................................................... 3496
AddImage(string) .................................................................................................................. 3497
Delete() ................................................................................................................................ 3497
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3497
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3498
PSDVelocity ................................................................................................................................ 3498
DataModelObjectCategory ................................................................................................... 3499
InternalObject ...................................................................................................................... 3499
LoadData .............................................................................................................................. 3499
Radiation .................................................................................................................................... 3499
AmbientTemperature ............................................................................................................ 3500
Correlation ........................................................................................................................... 3501
DataModelObjectCategory ................................................................................................... 3501
EditDataFor .......................................................................................................................... 3501
Emissivity ............................................................................................................................. 3501
Enclosure .............................................................................................................................. 3501
EnclosureType ...................................................................................................................... 3501
InternalObject ...................................................................................................................... 3502
Location ............................................................................................................................... 3502
NumberOfSegments ............................................................................................................. 3502
ShellFace .............................................................................................................................. 3502
GetActivateAtLoadStep(uint) ................................................................................................ 3502
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3503
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3503
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3503
RemoteDisplacement ................................................................................................................. 3504
BeamMaterial ....................................................................................................................... 3505
BeamRadius .......................................................................................................................... 3505
Behavior ............................................................................................................................... 3506
CoordinateSystem ................................................................................................................ 3506
DataModelObjectCategory ................................................................................................... 3506
DynamicRelaxationBehavior ................................................................................................. 3506
InternalObject ...................................................................................................................... 3506
Location ............................................................................................................................... 3506
NumberOfSegments ............................................................................................................. 3507
PinballRegion ....................................................................................................................... 3507
RemotePoint ......................................................................................................................... 3507
ReverseDirectionForInverseSteps .......................................................................................... 3507
RotationX ............................................................................................................................. 3507
RotationY ............................................................................................................................. 3507
RotationZ ............................................................................................................................. 3508
XComponent ........................................................................................................................ 3508
XCoordinate ......................................................................................................................... 3508
YComponent ........................................................................................................................ 3508
YCoordinate .......................................................................................................................... 3508
ZComponent ........................................................................................................................ 3508
ZCoordinate ......................................................................................................................... 3509
GetActivateAtLoadStep(uint) ................................................................................................ 3509
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3509

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

PromoteToRemotePoint() ...................................................................................................... 3509

SetActivateAtLoadStep(uint, bool) ......................................................................................... 3510
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3510
RemoteForce .............................................................................................................................. 3510
BeamMaterial ....................................................................................................................... 3512
BeamRadius .......................................................................................................................... 3512
Behavior ............................................................................................................................... 3513
CoordinateSystem ................................................................................................................ 3513
DataModelObjectCategory ................................................................................................... 3513
DefineBy ............................................................................................................................... 3513
Direction .............................................................................................................................. 3513
FollowerLoad ........................................................................................................................ 3513
HarmonicIndex ..................................................................................................................... 3514
IndependentVariable ............................................................................................................ 3514
InternalObject ...................................................................................................................... 3514
LoadingApplicationType ....................................................................................................... 3514
LoadStepVarying .................................................................................................................. 3514
Location ............................................................................................................................... 3514
Magnitude ............................................................................................................................ 3515
MagnitudeImag .................................................................................................................... 3515
NonCyclicLoadingType ......................................................................................................... 3515
NumberOfSegments ............................................................................................................. 3515
PhaseAngle .......................................................................................................................... 3515
PinballRegion ....................................................................................................................... 3515
RpmSelection ....................................................................................................................... 3516
SectorNumber ...................................................................................................................... 3516
StepSelection ....................................................................................................................... 3516
XComponent ........................................................................................................................ 3516
XComponentImag ................................................................................................................ 3516
XCoordinate ......................................................................................................................... 3516
XPhaseAngle ........................................................................................................................ 3517
YComponent ........................................................................................................................ 3517
YComponentImag ................................................................................................................ 3517
YCoordinate .......................................................................................................................... 3517
YPhaseAngle ........................................................................................................................ 3517
ZComponent ........................................................................................................................ 3517
ZComponentImag ................................................................................................................ 3518
ZCoordinate ......................................................................................................................... 3518
ZPhaseAngle ........................................................................................................................ 3518
GetActivateAtLoadStep(uint) ................................................................................................ 3518
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3518
PromoteToRemotePoint() ...................................................................................................... 3519
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3519
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3519
RotatingForce ............................................................................................................................. 3520
Axis ...................................................................................................................................... 3521
AxisComponentX .................................................................................................................. 3522
AxisComponentY .................................................................................................................. 3522
AxisComponentZ .................................................................................................................. 3522
AxisLocationX ....................................................................................................................... 3522
AxisLocationY ....................................................................................................................... 3522

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

AxisLocationZ ....................................................................................................................... 3522

CalculatedFromUnbalancedMass .......................................................................................... 3523
CoordinateSystem ................................................................................................................ 3523
DataModelObjectCategory ................................................................................................... 3523
DefineBy ............................................................................................................................... 3523
HitPointLocationX ................................................................................................................. 3523
HitPointLocationY ................................................................................................................. 3523
HitPointLocationZ ................................................................................................................. 3524
HitPointNodeId ..................................................................................................................... 3524
HitPointRemotePointSelection .............................................................................................. 3524
HitPointSelection .................................................................................................................. 3524
InternalObject ...................................................................................................................... 3524
Location ............................................................................................................................... 3524
Mass ..................................................................................................................................... 3525
PhaseAngle .......................................................................................................................... 3525
RemotePointSelection .......................................................................................................... 3525
RotatingRadius ..................................................................................................................... 3525
SynchronousRatio ................................................................................................................. 3525
UnbalancedForceMagnitude ................................................................................................. 3525
XCoordinate ......................................................................................................................... 3526
YCoordinate .......................................................................................................................... 3526
ZCoordinate ......................................................................................................................... 3526
RotationalAcceleration ................................................................................................................ 3526
CoordinateSystem ................................................................................................................ 3527
DataModelObjectCategory ................................................................................................... 3527
DefineBy ............................................................................................................................... 3528
IndependentVariable ............................................................................................................ 3528
InternalObject ...................................................................................................................... 3528
Location ............................................................................................................................... 3528
Magnitude ............................................................................................................................ 3528
XComponent ........................................................................................................................ 3528
XCoordinate ......................................................................................................................... 3529
YComponent ........................................................................................................................ 3529
YCoordinate .......................................................................................................................... 3529
ZComponent ........................................................................................................................ 3529
ZCoordinate ......................................................................................................................... 3529
RotationalVelocity ....................................................................................................................... 3529
CoordinateSystem ................................................................................................................ 3531
DataModelObjectCategory ................................................................................................... 3531
DefineBy ............................................................................................................................... 3531
IndependentVariable ............................................................................................................ 3531
InternalObject ...................................................................................................................... 3531
Location ............................................................................................................................... 3531
Magnitude ............................................................................................................................ 3532
XComponent ........................................................................................................................ 3532
XCoordinate ......................................................................................................................... 3532
YComponent ........................................................................................................................ 3532
YCoordinate .......................................................................................................................... 3532
ZComponent ........................................................................................................................ 3532
ZCoordinate ......................................................................................................................... 3533
RotationBoundaryCondition ....................................................................................................... 3533

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

Axis ...................................................................................................................................... 3534

Children ............................................................................................................................... 3534
Comments ............................................................................................................................ 3534
DataModelObjectCategory ................................................................................................... 3534
Figures ................................................................................................................................. 3534
Images ................................................................................................................................. 3534
InternalObject ...................................................................................................................... 3535
NumberOfSegments ............................................................................................................. 3535
Suppressed ........................................................................................................................... 3535
AddComment() ..................................................................................................................... 3535
AddFigure() .......................................................................................................................... 3535
AddImage(string) .................................................................................................................. 3535
Delete() ................................................................................................................................ 3536
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3536
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3536
RSAcceleration ............................................................................................................................ 3537
DataModelObjectCategory ................................................................................................... 3538
InternalObject ...................................................................................................................... 3538
LoadData .............................................................................................................................. 3538
RSDisplacement .......................................................................................................................... 3539
DataModelObjectCategory ................................................................................................... 3540
InternalObject ...................................................................................................................... 3540
LoadData .............................................................................................................................. 3540
RSLoad ....................................................................................................................................... 3540
BoundaryCondition .............................................................................................................. 3541
Children ............................................................................................................................... 3541
Comments ............................................................................................................................ 3542
DataModelObjectCategory ................................................................................................... 3542
Direction .............................................................................................................................. 3542
Figures ................................................................................................................................. 3542
Images ................................................................................................................................. 3542
InternalObject ...................................................................................................................... 3542
MissingMassEffect ................................................................................................................ 3543
MissingMassEffectZPA ........................................................................................................... 3543
RigidResponseEffect ............................................................................................................. 3543
RigidResponseEffectFreqBegin .............................................................................................. 3543
RigidResponseEffectFreqEnd ................................................................................................. 3543
RigidResponseEffectType ...................................................................................................... 3543
RigidResponseEffectZPA ....................................................................................................... 3544
ScaleFactor ........................................................................................................................... 3544
Suppressed ........................................................................................................................... 3544
AddComment() ..................................................................................................................... 3544
AddFigure() .......................................................................................................................... 3544
AddImage(string) .................................................................................................................. 3544
Delete() ................................................................................................................................ 3545
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3545
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3545
RSVelocity ................................................................................................................................... 3546
DataModelObjectCategory ................................................................................................... 3547
InternalObject ...................................................................................................................... 3547
LoadData .............................................................................................................................. 3547

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

SimplySupported ........................................................................................................................ 3548

DataModelObjectCategory ................................................................................................... 3548
InternalObject ...................................................................................................................... 3549
Location ............................................................................................................................... 3549
SurfaceChargeDensity ................................................................................................................ 3549
DataModelObjectCategory ................................................................................................... 3550
InternalObject ...................................................................................................................... 3550
Location ............................................................................................................................... 3550
Magnitude ............................................................................................................................ 3550
Temperature ............................................................................................................................... 3550
ApplyToEntireBody ............................................................................................................... 3552
DataModelObjectCategory ................................................................................................... 3552
GraphControlsXAxis .............................................................................................................. 3552
IndependentVariable ............................................................................................................ 3552
InternalObject ...................................................................................................................... 3552
Location ............................................................................................................................... 3552
Magnitude ............................................................................................................................ 3553
NumberOfSegments ............................................................................................................. 3553
RangeMaximum ................................................................................................................... 3553
RangeMinimum .................................................................................................................... 3553
ShellFace .............................................................................................................................. 3553
XYZFunctionCoordinateSystem ............................................................................................. 3553
GetActivateAtLoadStep(uint) ................................................................................................ 3554
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3554
ThermalCondition ....................................................................................................................... 3554
DataModelObjectCategory ................................................................................................... 3555
GraphControlsXAxis .............................................................................................................. 3556
IndependentVariable ............................................................................................................ 3556
InternalObject ...................................................................................................................... 3556
Location ............................................................................................................................... 3556
Magnitude ............................................................................................................................ 3556
NumberOfSegments ............................................................................................................. 3556
RangeMaximum ................................................................................................................... 3557
RangeMinimum .................................................................................................................... 3557
ShellFace .............................................................................................................................. 3557
XYZFunctionCoordinateSystem ............................................................................................. 3557
GetActivateAtLoadStep(uint) ................................................................................................ 3557
GetComponentActivateAtLoadStep(string, uint) .................................................................... 3558
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3558
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3558
Velocity ...................................................................................................................................... 3559
CoordinateSystem ................................................................................................................ 3560
DataModelObjectCategory ................................................................................................... 3560
DefineBy ............................................................................................................................... 3560
DynamicRelaxationBehavior ................................................................................................. 3560
InternalObject ...................................................................................................................... 3561
Location ............................................................................................................................... 3561
NumberOfSegments ............................................................................................................. 3561
XComponent ........................................................................................................................ 3561
YComponent ........................................................................................................................ 3561
ZComponent ........................................................................................................................ 3561

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

GetActivateAtLoadStep(uint) ................................................................................................ 3562

GetComponentActivateAtLoadStep(string, uint) .................................................................... 3562
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3562
SetComponentActivateAtLoadStep(string, uint, bool) ............................................................ 3563
ViscoelasticHeating ..................................................................................................................... 3563
DataModelObjectCategory ................................................................................................... 3564
InternalObject ...................................................................................................................... 3564
ViscoelasticLossFraction ........................................................................................................ 3564
Voltage ....................................................................................................................................... 3564
DataModelObjectCategory ................................................................................................... 3565
InternalObject ...................................................................................................................... 3565
Location ............................................................................................................................... 3566
Magnitude ............................................................................................................................ 3566
NumberOfSegments ............................................................................................................. 3566
PhaseAngle .......................................................................................................................... 3566
VoltageCoupling ................................................................................................................... 3566
GetActivateAtLoadStep(uint) ................................................................................................ 3566
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3567
VoltageGround ........................................................................................................................... 3567
DataModelObjectCategory ................................................................................................... 3568
InternalObject ...................................................................................................................... 3568
Location ............................................................................................................................... 3568
VoltageCoupling ................................................................................................................... 3568
VolumeChargeDensity ................................................................................................................ 3569
DataModelObjectCategory ................................................................................................... 3569
InternalObject ...................................................................................................................... 3570
Location ............................................................................................................................... 3570
Magnitude ............................................................................................................................ 3570
Ansys.ACT.Automation.Mechanical.AnalysisSettings Namespace ................................................ 3571
AnalysisSettings .......................................................................................................................... 3571
Children ............................................................................................................................... 3572
Comments ............................................................................................................................ 3572
DataModelObjectCategory ................................................................................................... 3572
Figures ................................................................................................................................. 3572
Graph ................................................................................................................................... 3572
Images ................................................................................................................................. 3573
InternalObject ...................................................................................................................... 3573
ScratchSolverFilesDirectory ................................................................................................... 3573
SolverFilesDirectory .............................................................................................................. 3573
AddComment() ..................................................................................................................... 3573
AddFigure() .......................................................................................................................... 3573
AddImage(string) .................................................................................................................. 3574
DeleteAllRestartPoints() ........................................................................................................ 3574
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3574
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3575
ANSYSAnalysisSettings ............................................................................................................... 3575
AggressiveRemeshing ........................................................................................................... 3591
AMCooldownNumberOfSubsteps ......................................................................................... 3591
AMPSConvergence ............................................................................................................... 3592
AMStepType ......................................................................................................................... 3592
AMSubstepsBetweenHeating ................................................................................................ 3592

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

AMSubstepsToApplyHeats .................................................................................................... 3592

AutomaticTimeStepping ....................................................................................................... 3592
AxisymmetryDivisions ........................................................................................................... 3592
BackStress ............................................................................................................................ 3593
BoundaryAngle .................................................................................................................... 3593
CacheResultsInMemory ........................................................................................................ 3593
CalculateAcceleration ........................................................................................................... 3593
CalculateEnergy .................................................................................................................... 3593
CalculateEulerAngles ............................................................................................................ 3593
CalculateReactions ................................................................................................................ 3594
CalculateThermalFlux ............................................................................................................ 3594
CalculateVelocity .................................................................................................................. 3594
CalculateVelocityAndAcceleration ......................................................................................... 3594
CalculateVolumeEnergy ........................................................................................................ 3594
CampbellDiagram ................................................................................................................. 3594
CarryOverTimeStep .............................................................................................................. 3595
CentralFrequency ................................................................................................................. 3595
ChargeConvergence ............................................................................................................. 3595
ChargeConvergenceMinimumReference ............................................................................... 3595
ChargeConvergenceTolerance ............................................................................................... 3595
ChargeConvergenceValue ..................................................................................................... 3595
ClusterNumber ..................................................................................................................... 3596
ClusterResults ....................................................................................................................... 3596
CombineRestartFiles ............................................................................................................. 3596
ConstantDamping ................................................................................................................ 3596
ConstantDampingRatio ........................................................................................................ 3596
ContactData ......................................................................................................................... 3596
ContactMiscellaneous ........................................................................................................... 3597
ContactSplit .......................................................................................................................... 3597
ContactSplitMaxNum ............................................................................................................ 3597
ContactSummary .................................................................................................................. 3597
CooldownTime ..................................................................................................................... 3597
CooldownTimeType .............................................................................................................. 3597
CoriolisEffect ........................................................................................................................ 3598
CreepEffects ......................................................................................................................... 3598
CreepLimitRatio .................................................................................................................... 3598
CSGConvergence .................................................................................................................. 3598
CStarIntegral ......................................................................................................................... 3598
CurrentConvergence ............................................................................................................. 3598
CurrentConvergenceMinimumReference ............................................................................... 3599
CurrentConvergenceTolerance .............................................................................................. 3599
CurrentConvergenceValue .................................................................................................... 3599
CurrentRestartPoint .............................................................................................................. 3599
CurrentStepNumber ............................................................................................................. 3599
CurrentStepNumberHarmonic .............................................................................................. 3599
CyclicModeSuperposition ..................................................................................................... 3600
Damped ............................................................................................................................... 3600
DampingDefineBy ................................................................................................................ 3600
DampingRatio ...................................................................................................................... 3600
DataModelObjectCategory ................................................................................................... 3600
DefineBy ............................................................................................................................... 3600

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

DeleteUnneededFiles ............................................................................................................ 3601

DisplacementConvergence ................................................................................................... 3601
DisplacementConvergenceMinimumReference ..................................................................... 3601
DisplacementConvergenceTolerance .................................................................................... 3601
DisplacementConvergenceValue ........................................................................................... 3601
EdgeSplittingAngle ............................................................................................................... 3601
ElectromagneticNodalForces ................................................................................................ 3602
ElementCurrentDensity ......................................................................................................... 3602
EmagAMPSConvergenceMinimumReference ......................................................................... 3602
EmagAMPSConvergenceTolerance ........................................................................................ 3602
EmagAMPSConvergenceValue .............................................................................................. 3602
EmagCSGConvergenceMinimumReference ........................................................................... 3602
EmagCSGConvergenceTolerance ........................................................................................... 3603
EmagCSGConvergenceValue ................................................................................................. 3603
EngineOrderofExcitation ....................................................................................................... 3603
EqvDampingRatioFromModal ............................................................................................... 3603
ExcludeInsignificantModes ................................................................................................... 3603
ExpandResultsFrom .............................................................................................................. 3603
Expansion ............................................................................................................................. 3604
ExportLayerEndTemperature ................................................................................................. 3604
ExportRecoaterInterference .................................................................................................. 3604
FarFieldRadiationSurface ....................................................................................................... 3604
FluxConvergence .................................................................................................................. 3604
ForceConvergence ................................................................................................................ 3604
ForceConvergenceMinimumReference .................................................................................. 3605
ForceConvergenceTolerance ................................................................................................. 3605
ForceConvergenceValue ........................................................................................................ 3605
FractureSolverControls .......................................................................................................... 3605
Frequency ............................................................................................................................ 3605
FrequencySpacing ................................................................................................................ 3605
FutureAnalysis ...................................................................................................................... 3606
GeneralMiscellaneous ........................................................................................................... 3606
GeneralMiscellaneousOption ................................................................................................ 3606
GenerateMeshRestartPoints .................................................................................................. 3606
GenerateRestartPoints .......................................................................................................... 3606
GlobalSizeRatioQualityImprovement ..................................................................................... 3606
GlobalSizeRatioQualityRefinement ........................................................................................ 3607
HarmonicIndexInterval ......................................................................................................... 3607
HarmonicIndexRange ........................................................................................................... 3607
HeatConvergence ................................................................................................................. 3607
HeatConvergenceMinimumReference ................................................................................... 3607
HeatConvergenceTolerance .................................................................................................. 3607
HeatConvergenceValue ......................................................................................................... 3608
HeatGenerationRate ............................................................................................................. 3608
HemicubeResolution ............................................................................................................ 3608
IgnoreAcousticDamping ....................................................................................................... 3608
IncludeNegativeLoadMultiplier ............................................................................................. 3608
IncludeResidualVector .......................................................................................................... 3608
InertiaRelief .......................................................................................................................... 3609
InitialSubsteps ...................................................................................................................... 3609
InitialTimeStep ..................................................................................................................... 3609

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

InternalObject ...................................................................................................................... 3609

InverseOption ....................................................................................................................... 3609
InverseOptionEndStep .......................................................................................................... 3609
JIntegral ............................................................................................................................... 3610
KeepModalResults ................................................................................................................ 3610
KeepPreStressLoadPattern .................................................................................................... 3610
LargeDeflection .................................................................................................................... 3610
LayersToBuild ....................................................................................................................... 3610
LimitSearchToRange ............................................................................................................. 3610
LineSearch ............................................................................................................................ 3611
LoadStepValue ...................................................................................................................... 3611
MassCoefficient .................................................................................................................... 3611
MaterialForce ........................................................................................................................ 3611
MaximumHarmonicIndex ...................................................................................................... 3611
MaximumIteration ................................................................................................................ 3611
MaximumModesToFind ........................................................................................................ 3612
MaximumPointsToSavePerStep ............................................................................................. 3612
MaximumSubsteps ............................................................................................................... 3612
MaximumTimeStep .............................................................................................................. 3612
MeshLoadStepValue ............................................................................................................. 3612
MeshRetainFilesAfterFullSolve ............................................................................................... 3612
MeshSaveAtLoadStep ........................................................................................................... 3613
MeshSaveAtSubstep ............................................................................................................. 3613
MinimumHarmonicIndex ...................................................................................................... 3613
MinimumSubsteps ................................................................................................................ 3613
MinimumTimeStep ............................................................................................................... 3613
ModalFrequencyRange ......................................................................................................... 3613
ModalNumberOfPoints ......................................................................................................... 3614
ModalRangeMaximum .......................................................................................................... 3614
ModalRangeMinimum .......................................................................................................... 3614
ModeReuse .......................................................................................................................... 3614
ModesCombinationType ....................................................................................................... 3614
ModeSignificanceLevel ......................................................................................................... 3614
MomentConvergence ........................................................................................................... 3615
MomentConvergenceMinimumReference ............................................................................. 3615
MomentConvergenceTolerance ............................................................................................ 3615
MomentConvergenceValue ................................................................................................... 3615
Multistep .............................................................................................................................. 3615
MultistepType ....................................................................................................................... 3615
NewtonRaphsonOption ........................................................................................................ 3616
NodalForces .......................................................................................................................... 3616
NonlinearData ...................................................................................................................... 3616
NonLinearFormulation .......................................................................................................... 3616
NonLinearSolution ................................................................................................................ 3616
NumberOfModesToUse ......................................................................................................... 3616
NumberOfRestartPoints ........................................................................................................ 3617
NumberOfRPMs .................................................................................................................... 3617
NumberOfSculptedLayersQualityImprovement ..................................................................... 3617
NumberOfSculptedLayersRefinement ................................................................................... 3617
NumberOfSteps .................................................................................................................... 3617
NumberOfSubSteps .............................................................................................................. 3617

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

NumberOfZones ................................................................................................................... 3618

NumericalDamping .............................................................................................................. 3618
NumericalDampingValue ...................................................................................................... 3618
OnDemandExpansion ........................................................................................................... 3618
OverRelaxation ..................................................................................................................... 3618
ParticipationFactor ................................................................................................................ 3618
ProjectToGeometry ............................................................................................................... 3619
QuasiStaticSolution .............................................................................................................. 3619
RadiositySolver ..................................................................................................................... 3619
RangeMaximum ................................................................................................................... 3619
RangeMinimum .................................................................................................................... 3619
ReferenceTemperature .......................................................................................................... 3619
ReferenceTemperatureType .................................................................................................. 3620
RefinementAlgorithm ........................................................................................................... 3620
ReformulationTolerance ........................................................................................................ 3620
RelaxationTemperature ......................................................................................................... 3620
RelaxationTemperatureType ................................................................................................. 3620
RemeshingGradient .............................................................................................................. 3620
RemeshingToleranceQualityImprovement ............................................................................. 3621
RemeshingToleranceRefinement ........................................................................................... 3621
RestartAtLoadStep ................................................................................................................ 3621
RestartAtSubstep .................................................................................................................. 3621
RestartAtTime ....................................................................................................................... 3621
RestartType .......................................................................................................................... 3621
ResultFileCompression .......................................................................................................... 3622
RetainFilesAfterFullSolve ....................................................................................................... 3622
RetainModesymFileAfterSolve ............................................................................................... 3622
RotationConvergence ........................................................................................................... 3622
RotationConvergenceMinimumReference ............................................................................. 3622
RotationConvergenceTolerance ............................................................................................ 3622
RpmClusterNumber .............................................................................................................. 3623
RpmFrequencySpacing ......................................................................................................... 3623
RpmRangeMaximum ............................................................................................................ 3623
RpmRangeMinimum ............................................................................................................. 3623
RpmSolutionIntervals ........................................................................................................... 3623
RpmValue ............................................................................................................................. 3623
SaveAtLoadStep ................................................................................................................... 3624
SaveAtSubstep ..................................................................................................................... 3624
SaveMAPDLDB ...................................................................................................................... 3624
SaveSpecifiedLoadStep ......................................................................................................... 3624
ScatteredFieldFormulation .................................................................................................... 3624
ScatteringOutputType .......................................................................................................... 3624
SearchRangeMaximum ......................................................................................................... 3625
SearchRangeMinimum .......................................................................................................... 3625
SIFS ...................................................................................................................................... 3625
SolutionIntervals ................................................................................................................... 3625
SolutionMethod ................................................................................................................... 3625
SolverPivotChecking ............................................................................................................. 3625
SolverTolerance .................................................................................................................... 3626
SolverType ............................................................................................................................ 3626
SolverUnits ........................................................................................................................... 3626

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

SolverUnitSystem ................................................................................................................. 3626

SpectrumType ...................................................................................................................... 3626
SpinSoftening ....................................................................................................................... 3626
SpringStiffness ...................................................................................................................... 3627
SpringStiffnessFactor ............................................................................................................ 3627
SpringStiffnessValue ............................................................................................................. 3627
Stabilization .......................................................................................................................... 3627
StabilizationActivationForFirstSubstep .................................................................................. 3627
StabilizationDampingFactor .................................................................................................. 3627
StabilizationEnergyDissipationRatio ...................................................................................... 3628
StabilizationForceLimit .......................................................................................................... 3628
StabilizationMethod ............................................................................................................. 3628
StepEndTime ........................................................................................................................ 3628
StepName ............................................................................................................................ 3628
StiffnessCoefficient ............................................................................................................... 3628
StiffnessCoefficientDefineBy ................................................................................................. 3629
StoreComplexSolution .......................................................................................................... 3629
StoreModalResults ................................................................................................................ 3629
StoreResulsAtValue ............................................................................................................... 3629
StoreResultsAt ...................................................................................................................... 3629
StoreResultsAtAllFrequencies ................................................................................................ 3629
Strain .................................................................................................................................... 3630
Stress ................................................................................................................................... 3630
StructuralDampingCoefficient ............................................................................................... 3630
StructuralOnly ...................................................................................................................... 3630
SurfaceStress ........................................................................................................................ 3630
TemperatureConvergence ..................................................................................................... 3630
TemperatureConvergenceInputValue .................................................................................... 3631
TemperatureConvergenceMinimumReference ....................................................................... 3631
TemperatureConvergenceTolerance ...................................................................................... 3631
TemperatureConvergenceValue ............................................................................................ 3631
ThermalOnly ......................................................................................................................... 3631
TimeIntegration .................................................................................................................... 3631
TimeStep .............................................................................................................................. 3632
TransientApplication ............................................................................................................. 3632
TransientApplicationUserDefined .......................................................................................... 3632
TStress .................................................................................................................................. 3632
UserDefinedFrequencies ....................................................................................................... 3632
UserDefinedFrequencySteps ................................................................................................. 3632
VariationalTechnology .......................................................................................................... 3633
ViewFactorMethod ............................................................................................................... 3633
VoltageConvergence ............................................................................................................. 3633
VoltageConvergenceMinimumReference ............................................................................... 3633
VoltageConvergenceTolerance .............................................................................................. 3633
VoltageConvergenceValue .................................................................................................... 3633
WeakSprings ......................................................................................................................... 3634
GetAMStepType(uint) ........................................................................................................... 3634
GetAutomaticTimeStepping(uint) ......................................................................................... 3634
GetCarryOverTimeStep(uint) ................................................................................................. 3634
GetCreepEffects(uint) ............................................................................................................ 3635
GetCreepLimitRatio(uint) ...................................................................................................... 3635

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

GetCurrentConvergenceMinimumReference(uint) ................................................................. 3635

GetCurrentConvergenceTolerance(uint) ................................................................................ 3636
GetCurrentConvergenceType(uint) ........................................................................................ 3636
GetCurrentConvergenceValue(uint) ....................................................................................... 3636
GetDefineBy(uint) ................................................................................................................. 3636
GetDisplacementConvergenceMinimumReference(uint) ....................................................... 3637
GetDisplacementConvergenceTolerance(uint) ....................................................................... 3637
GetDisplacementConvergenceType(uint) .............................................................................. 3637
GetDisplacementConvergenceValue(uint) ............................................................................. 3638
GetEmagAMPSConvergenceMinimumReference(uint) ........................................................... 3638
GetEmagAMPSConvergenceTolerance(uint) .......................................................................... 3638
GetEmagAMPSConvergenceType(uint) .................................................................................. 3638
GetEmagAMPSConvergenceValue(uint) ................................................................................. 3639
GetEmagCSGConvergenceMinimumReference(uint) .............................................................. 3639
GetEmagCSGConvergenceTolerance(uint) ............................................................................. 3639
GetEmagCSGConvergenceType(uint) .................................................................................... 3640
GetEmagCSGConvergenceValue(uint) ................................................................................... 3640
GetForceConvergenceMinimumReference(uint) .................................................................... 3640
GetForceConvergenceTolerance(uint) .................................................................................... 3640
GetForceConvergenceType(uint) ........................................................................................... 3641
GetForceConvergenceValue(uint) .......................................................................................... 3641
GetHeatConvergenceMinimumReference(uint) ..................................................................... 3641
GetHeatConvergenceTolerance(uint) ..................................................................................... 3642
GetHeatConvergenceType(uint) ............................................................................................ 3642
GetHeatConvergenceValue(uint) ........................................................................................... 3642
GetInitialSubsteps(uint) ........................................................................................................ 3642
GetInitialTimeStep(uint) ........................................................................................................ 3643
GetLineSearch(uint) .............................................................................................................. 3643
GetMaximumSubsteps(uint) ................................................................................................. 3643
GetMaximumTimeStep(uint) ................................................................................................. 3644
GetMinimumSubsteps(uint) .................................................................................................. 3644
GetMinimumTimeStep(uint) ................................................................................................. 3644
GetMomentConvergenceMinimumReference(uint) ............................................................... 3644
GetMomentConvergenceTolerance(uint) ............................................................................... 3645
GetMomentConvergenceType(uint) ...................................................................................... 3645
GetMomentConvergenceValue(uint) ..................................................................................... 3645
GetNumberOfSubSteps(uint) ................................................................................................ 3646
GetRotationConvergenceMinimumReference(uint) ............................................................... 3646
GetRotationConvergenceTolerance(uint) ............................................................................... 3646
GetRotationConvergenceType(uint) ...................................................................................... 3646
GetRotationConvergenceValue(uint) ..................................................................................... 3647
GetStabilization(uint) ............................................................................................................ 3647
GetStabilizationDampingFactor(uint) .................................................................................... 3647
GetStabilizationEnergyDissipationRatio(uint) ........................................................................ 3648
GetStabilizationFirstSubstepOption(uint) .............................................................................. 3648
GetStabilizationForceLimit(uint) ............................................................................................ 3648
GetStabilizationMethod(uint) ................................................................................................ 3648
GetStepEndTime(uint) .......................................................................................................... 3649
GetStepName(uint) ............................................................................................................... 3649
GetStoreResulsAtValue(uint) ................................................................................................. 3649
GetStoreResultsAt(uint) ......................................................................................................... 3650

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

GetStructuralOnly(uint) ......................................................................................................... 3650

GetTemperatureConvergenceInputValue(uint) ...................................................................... 3650
GetTemperatureConvergenceMinimumReference(uint) ......................................................... 3650
GetTemperatureConvergenceTolerance(uint) ........................................................................ 3651
GetTemperatureConvergenceType(uint) ................................................................................ 3651
GetTemperatureConvergenceValue(uint) ............................................................................... 3651
GetThermalOnly(uint) ........................................................................................................... 3652
GetTimeIntegration(uint) ...................................................................................................... 3652
GetTimeStep(uint) ................................................................................................................ 3652
GetVoltageConvergenceMinimumReference(uint) ................................................................. 3652
GetVoltageConvergenceTolerance(uint) ................................................................................ 3653
GetVoltageConvergenceType(uint) ........................................................................................ 3653
GetVoltageConvergenceValue(uint) ....................................................................................... 3653
SetAutomaticTimeStepping(uint, AutomaticTimeStepping) ................................................... 3654
SetCarryOverTimeStep(uint, bool) ......................................................................................... 3654
SetChargeConvergenceMinimumReference(uint, Quantity) ................................................... 3654
SetChargeConvergenceTolerance(uint, double) ..................................................................... 3655
SetChargeConvergenceType(uint, ConvergenceToleranceType) ............................................. 3655
SetChargeConvergenceValue(uint, Quantity) ......................................................................... 3655
SetCreepEffects(uint, Creep) .................................................................................................. 3656
SetCreepLimitRatio(uint, double) ........................................................................................... 3656
SetCurrentConvergenceMinimumReference(uint, Quantity) ................................................... 3656
SetCurrentConvergenceTolerance(uint, double) ..................................................................... 3657
SetCurrentConvergenceType(uint, ConvergenceToleranceType) ............................................. 3657
SetCurrentConvergenceValue(uint, Quantity) ......................................................................... 3658
SetDefineBy(uint, TimeStepDefineByType) ............................................................................. 3658
SetDisplacementConvergenceMinimumReference(uint, Quantity) ......................................... 3658
SetDisplacementConvergenceTolerance(uint, double) ........................................................... 3659
SetDisplacementConvergenceType(uint, ConvergenceToleranceType) ................................... 3659
SetDisplacementConvergenceValue(uint, Quantity) ............................................................... 3659
SetEmagAMPSConvergenceMinimumReference(uint, Quantity) ............................................. 3660
SetEmagAMPSConvergenceTolerance(uint, double) ............................................................... 3660
SetEmagAMPSConvergenceType(uint, ConvergenceToleranceType) ....................................... 3660
SetEmagAMPSConvergenceValue(uint, Quantity) ................................................................... 3661
SetEmagCSGConvergenceMinimumReference(uint, Quantity) ............................................... 3661
SetEmagCSGConvergenceTolerance(uint, double) ................................................................. 3662
SetEmagCSGConvergenceType(uint, ConvergenceToleranceType) ......................................... 3662
SetEmagCSGConvergenceValue(uint, Quantity) ..................................................................... 3662
SetForceConvergenceMinimumReference(uint, Quantity) ...................................................... 3663
SetForceConvergenceTolerance(uint, double) ........................................................................ 3663
SetForceConvergenceType(uint, ConvergenceToleranceType) ................................................ 3663
SetForceConvergenceValue(uint, Quantity) ............................................................................ 3664
SetHeatConvergenceMinimumReference(uint, Quantity) ....................................................... 3664
SetHeatConvergenceTolerance(uint, double) ......................................................................... 3664
SetHeatConvergenceType(uint, ConvergenceToleranceType) ................................................. 3665
SetHeatConvergenceValue(uint, Quantity) ............................................................................. 3665
SetInitialSubsteps(uint, uint) .................................................................................................. 3666
SetInitialTimeStep(uint, Quantity) .......................................................................................... 3666
SetLineSearch(uint, LineSearchType) ..................................................................................... 3666
SetMaximumSubsteps(uint, uint) ........................................................................................... 3667
SetMaximumTimeStep(uint, Quantity) ................................................................................... 3667

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

SetMinimumSubsteps(uint, uint) ........................................................................................... 3667

SetMinimumTimeStep(uint, Quantity) ................................................................................... 3668
SetMomentConvergenceMinimumReference(uint, Quantity) ................................................. 3668
SetMomentConvergenceTolerance(uint, double) ................................................................... 3668
SetMomentConvergenceType(uint, ConvergenceToleranceType) ........................................... 3669
SetMomentConvergenceValue(uint, Quantity) ....................................................................... 3669
SetNumberOfSubSteps(uint, uint) ......................................................................................... 3670
SetRotationConvergenceMinimumReference(uint, Quantity) ................................................. 3670
SetRotationConvergenceTolerance(uint, double) ................................................................... 3670
SetRotationConvergenceType(uint, ConvergenceToleranceType) ........................................... 3671
SetRotationConvergenceValue(uint, Quantity) ....................................................................... 3671
SetStabilization(uint, StabilizationType) ................................................................................. 3671
SetStabilizationDampingFactor(uint, double) ......................................................................... 3672
SetStabilizationEnergyDissipationRatio(uint, double) ............................................................. 3672
SetStabilizationFirstSubstepOption(uint, StabilizationFirstSubstepOption) ............................. 3672
SetStabilizationForceLimit(uint, double) ................................................................................ 3673
SetStabilizationMethod(uint, StabilizationMethod) ................................................................ 3673
SetStepEndTime(uint, Quantity) ............................................................................................ 3674
SetStepName(uint, string) ..................................................................................................... 3674
SetStoreResulsAtValue(uint, uint) ........................................................................................... 3674
SetStoreResultsAt(uint, TimePointsOptions) ........................................................................... 3675
SetStructuralOnly(uint, bool) ................................................................................................. 3675
SetTemperatureConvergenceInputValue(uint, Quantity) ........................................................ 3675
SetTemperatureConvergenceMinimumReference(uint, Quantity) ........................................... 3676
SetTemperatureConvergenceTolerance(uint, double) ............................................................. 3676
SetTemperatureConvergenceType(uint, ConvergenceToleranceType) ..................................... 3676
SetTemperatureConvergenceValue(uint, NonLinearValueType) .............................................. 3677
SetThermalOnly(uint, bool) ................................................................................................... 3677
SetTimeIntegration(uint, bool) .............................................................................................. 3678
SetTimeStep(uint, Quantity) .................................................................................................. 3678
SetVoltageConvergenceMinimumReference(uint, Quantity) ................................................... 3678
SetVoltageConvergenceTolerance(uint, double) ..................................................................... 3679
SetVoltageConvergenceType(uint, ConvergenceToleranceType) ............................................. 3679
SetVoltageConvergenceValue(uint, Quantity) ........................................................................ 3679
EXDAnalysisSettings ................................................................................................................... 3680
ArtificialViscosityForShellsType ............................................................................................. 3685
AutomaticMassScalingType .................................................................................................. 3685
BeamSolutionType ................................................................................................................ 3685
BeamTimeStepSafetyFactor .................................................................................................. 3686
CharZoneDimensionType ...................................................................................................... 3686
CurrentStepNumber ............................................................................................................. 3686
DensityUpdateType .............................................................................................................. 3686
DetonationBurnType ............................................................................................................ 3686
ErosionGeomStrainLimit ....................................................................................................... 3686
ErosionMinElemTimestep ..................................................................................................... 3687
ErosionOnGeomStrainType ................................................................................................... 3687
ErosionOnMaterialFailureType ............................................................................................... 3687
ErosionOnMinElemTimestepType .......................................................................................... 3687
ErosionRetainIntertiaType ..................................................................................................... 3687
EulerBoundLowerX ............................................................................................................... 3687
EulerBoundLowerY ............................................................................................................... 3688

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

EulerBoundLowerZ ............................................................................................................... 3688

EulerBoundUpperX ............................................................................................................... 3688
EulerBoundUpperY ............................................................................................................... 3688
EulerBoundUpperZ ............................................................................................................... 3688
EulerCellSize ......................................................................................................................... 3688
EulerDisplayBox .................................................................................................................... 3689
EulerDomainType ................................................................................................................. 3689
EulerDomScopeDefType ....................................................................................................... 3689
EulerGradedDefinition .......................................................................................................... 3689
EulerGradeIncrement ............................................................................................................ 3689
EulerGradeNumberOfTimes .................................................................................................. 3689
EulerPropertyDisplayBox ....................................................................................................... 3690
EulerPropertyXmin ............................................................................................................... 3690
EulerPropertyXres ................................................................................................................. 3690
EulerPropertyXsize ................................................................................................................ 3690
EulerPropertyYmin ................................................................................................................ 3690
EulerPropertyYres ................................................................................................................. 3690
EulerPropertyYsize ................................................................................................................ 3691
EulerPropertyZmin ............................................................................................................... 3691
EulerPropertyZres ................................................................................................................. 3691
EulerPropertyZsize ................................................................................................................ 3691
EulerResolutionDefType ........................................................................................................ 3691
EulerSizeDefType .................................................................................................................. 3691
EulerTotalCells ...................................................................................................................... 3692
EulerTrackType ..................................................................................................................... 3692
EulerXDim ............................................................................................................................ 3692
EulerXOrigin ......................................................................................................................... 3692
EulerXScaleFactor ................................................................................................................. 3692
EulerXZones ......................................................................................................................... 3692
EulerYDim ............................................................................................................................ 3693
EulerYOrigin ......................................................................................................................... 3693
EulerYScaleFactor ................................................................................................................. 3693
EulerYZones ......................................................................................................................... 3693
EulerZDim ............................................................................................................................ 3693
EulerZOrigin ......................................................................................................................... 3693
EulerZScaleFactor ................................................................................................................. 3694
EulerZZones ......................................................................................................................... 3694
HexIntegrationType .............................................................................................................. 3694
HourglassDampingType ........................................................................................................ 3694
InitialTimeStep ..................................................................................................................... 3694
InternalObject ...................................................................................................................... 3694
LinearArtificialViscosity ......................................................................................................... 3695
LinearViscosityExpansionType ............................................................................................... 3695
LinearViscositySPH ................................................................................................................ 3695
MassScalingMaxElem ............................................................................................................ 3695
MassScalingMaxPart ............................................................................................................. 3695
MassScalingMinTimeStep ..................................................................................................... 3695
MassScalingUpdateFreq ........................................................................................................ 3696
MaximumEnergyError ........................................................................................................... 3696
MaximumTimeStep .............................................................................................................. 3696
MaximumTimeSteps ............................................................................................................. 3696

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

MaximumVelocity ................................................................................................................. 3696

MinimumStrainCutOff ........................................................................................................... 3696
MinimumTimeStep ............................................................................................................... 3697
MinimumVelocity ................................................................................................................. 3697
NumberOfSteps .................................................................................................................... 3697
OutputContactForcesOnPoints .............................................................................................. 3697
OutputContactForcesOnTime ............................................................................................... 3697
OutputContactForcesOnTimeSteps ....................................................................................... 3697
OutputContactForcesOnType ................................................................................................ 3698
OutputRemapFile ................................................................................................................. 3698
PreferenceType ..................................................................................................................... 3698
PusoCoefficient ..................................................................................................................... 3698
QuadraticArtificialViscosity ................................................................................................... 3698
QuadratricViscositySPH ......................................................................................................... 3698
RadiusCutoff ......................................................................................................................... 3699
ReferenceEnergyTimeStep .................................................................................................... 3699
ResumeFromTimeStep .......................................................................................................... 3699
SavePrintSummaryOnTime ................................................................................................... 3699
SavePrintSummaryOnTimeSteps ........................................................................................... 3699
SavePrintSummaryOnType .................................................................................................... 3699
SaveUserEditOnTime ............................................................................................................ 3700
SaveUserEditOnTimeSteps .................................................................................................... 3700
SaveUserEditOnType ............................................................................................................. 3700
ShellInertiaUpdateType ......................................................................................................... 3700
ShellShearCorrectionFactor ................................................................................................... 3700
ShellSublayers ...................................................................................................................... 3700
ShellThicknessUpdateType .................................................................................................... 3701
ShellWarpCorrection ............................................................................................................. 3701
SolverPrecisionType .............................................................................................................. 3701
SolveUnits ............................................................................................................................ 3701
SPHMaxDensityFactor ........................................................................................................... 3701
SPHMinDensityFactor ........................................................................................................... 3701
SphMinTimeStep .................................................................................................................. 3702
SPHNodeDensityCutoffOption .............................................................................................. 3702
StepawareMassScalingType .................................................................................................. 3702
StepawareOutputControlsType ............................................................................................. 3702
StiffnessCoefficient ............................................................................................................... 3702
TetPressureIntegrationType ................................................................................................... 3702
TimeStepSafetyFactor ........................................................................................................... 3703
ViscousCoefficient ................................................................................................................ 3703
ViscousCoefficientFB ............................................................................................................. 3703
getADRConvergenceMethod(int) .......................................................................................... 3703
getADRConvergenceTolerance(int) ........................................................................................ 3703
getADRMaximumIterations(int) ............................................................................................. 3704
GetAutomaticMassScalingType(int) ....................................................................................... 3704
GetLoadStepType(int) ........................................................................................................... 3704
GetMassScalingMinTimeStep(int) .......................................................................................... 3705
GetSaveProbeDataOnTime(int) ............................................................................................. 3705
GetSaveProbeDataOnTimeSteps(int) ..................................................................................... 3705
GetSaveProbeDataOnType(int) .............................................................................................. 3706
GetSaveRestartsOnPoints(int) ................................................................................................ 3706

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

GetSaveRestartsOnTime(int) ................................................................................................. 3706

GetSaveRestartsOnTimeSteps(int) ......................................................................................... 3706
GetSaveRestartsOnType(int) .................................................................................................. 3707
GetSaveResultsOnPoints(int) ................................................................................................. 3707
GetSaveResultsOnTime(int) ................................................................................................... 3707
GetSaveResultsOnTimeSteps(int) .......................................................................................... 3708
GetSaveResultsOnType(int) ................................................................................................... 3708
GetStaticDamping(int) .......................................................................................................... 3708
GetStepEndTime(int) ............................................................................................................ 3708
setADRConvergenceMethod(int, EXDADRConvergenceMethod) ............................................ 3709
setADRConvergenceTolerance(int, double) ............................................................................ 3709
setADRMaximumIterations(int, int) ........................................................................................ 3709
SetAutomaticMassScalingType(int, EXDAutomaticMassScalingType) ...................................... 3710
SetLoadStepType(int, EXDLoadStepType) .............................................................................. 3710
SetMassScalingMinTimeStep(int, Quantity) ............................................................................ 3710
SetSaveProbeDataOnTime(int, Quantity) ............................................................................... 3711
SetSaveProbeDataOnTimeSteps(int, int) ................................................................................ 3711
SetSaveProbeDataOnType(int, EXDSaveProbeDataOnType) ................................................... 3712
SetSaveRestartsOnPoints(int, int) ........................................................................................... 3712
SetSaveRestartsOnTime(int, Quantity) ................................................................................... 3712
SetSaveRestartsOnTimeSteps(int, int) .................................................................................... 3713
SetSaveRestartsOnType(int, EXDSaveRestartsOnType) ........................................................... 3713
SetSaveResultsOnPoints(int, int) ............................................................................................ 3713
SetSaveResultsOnTime(int, Quantity) ..................................................................................... 3714
SetSaveResultsOnTimeSteps(int, int) ...................................................................................... 3714
SetSaveResultsOnType(int, EXDSaveResultsOnType) .............................................................. 3714
SetStaticDamping(int, double) .............................................................................................. 3715
SetStepEndTime(int, Quantity) .............................................................................................. 3715
RBDAnalysisSettings ................................................................................................................... 3716
AssemblyType ...................................................................................................................... 3718
ConstraintEquationResidualTolerance ................................................................................... 3718
ConstraintEquationResidualToleranceValue ........................................................................... 3719
CorrectionType ..................................................................................................................... 3719
CurrentStepNumber ............................................................................................................. 3719
DropoffTolerance .................................................................................................................. 3719
EnergyAccuracyTolerance ..................................................................................................... 3719
EnergyAccuracyToleranceValue ............................................................................................. 3719
ForceResidualTolerance ......................................................................................................... 3720
ForceResidualToleranceValue ................................................................................................ 3720
InternalObject ...................................................................................................................... 3720
NumberOfSteps .................................................................................................................... 3720
NumericalDampingTolerance ................................................................................................ 3720
NumericalDampingValue ...................................................................................................... 3720
PerformStaticAnalysis ........................................................................................................... 3721
PositionCorrection ................................................................................................................ 3721
RelativeAssemblyTolerance ................................................................................................... 3721
RelativeAssemblyToleranceValue ........................................................................................... 3721
TimeIntegrationType ............................................................................................................ 3721
VelocityConstraintEquationResidualTolerance ....................................................................... 3721
VelocityConstraintEquationResidualToleranceValue ............................................................... 3722
VelocityCorrection ................................................................................................................ 3722

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

GetAutomaticTimeStepping(int) ........................................................................................... 3722

GetCarryOverTimeStep(int) ................................................................................................... 3722
GetInitialTimeStep(int) .......................................................................................................... 3723
GetMaximumTimeStep(int) ................................................................................................... 3723
GetMinimumTimeStep(int) ................................................................................................... 3723
GetStepEndTime(int) ............................................................................................................ 3723
GetStoreResultAt(int) ............................................................................................................ 3724
GetStoreResultAtValue(int) .................................................................................................... 3724
GetTimeStep(int) .................................................................................................................. 3724
SetAutomaticTimeStepping(int, AutomaticTimeStepping) ..................................................... 3725
SetCarryOverTimeStep(int, bool) ........................................................................................... 3725
SetInitialTimeStep(int, Quantity) ............................................................................................ 3725
SetMaximumTimeStep(int, Quantity) ..................................................................................... 3726
SetMinimumTimeStep(int, Quantity) ..................................................................................... 3726
SetStepEndTime(int, Quantity) .............................................................................................. 3726
SetStoreResultAt(int, TimePointsOptions) .............................................................................. 3727
SetStoreResultAtValue(int, int) ............................................................................................... 3727
SetTimeStep(int, Quantity) .................................................................................................... 3727
TopoOptAnalysisSettings ............................................................................................................ 3728
ConvergenceAccuracy .......................................................................................................... 3729
DataModelObjectCategory ................................................................................................... 3729
DeleteUnneededFiles ............................................................................................................ 3730
ExportDesignProperties ........................................................................................................ 3730
ExportDesignPropertiesFileFormat ........................................................................................ 3730
ExportKnockdownFilePath .................................................................................................... 3730
Filter ..................................................................................................................................... 3730
FutureAnalysis ...................................................................................................................... 3730
InternalObject ...................................................................................................................... 3731
MaximumNumberOfIterations .............................................................................................. 3731
MaxNumOfIntermediateFiles ................................................................................................ 3731
MinimumNormalizedDensity ................................................................................................ 3731
OptimizationOutputLog ........................................................................................................ 3731
PenaltyFactor ........................................................................................................................ 3731
RegionOfAMOverhangConstraint .......................................................................................... 3732
RegionOfManufacturingConstraint ....................................................................................... 3732
RegionOfMinMemberSize ..................................................................................................... 3732
SaveMAPDLDB ...................................................................................................................... 3732
SolverType ............................................................................................................................ 3732
SolverUnits ........................................................................................................................... 3732
SolverUnitSystem ................................................................................................................. 3733
StoreResultsAt ...................................................................................................................... 3733
StoreResultsAtValue .............................................................................................................. 3733
TopoOptInitialDensity ........................................................................................................... 3733
Ansys.ACT.Automation.Mechanical.AdditiveManufacturing Namespace ..................................... 3735
AMBuildSettings ......................................................................................................................... 3735
AdditiveProcess .................................................................................................................... 3738
ASCParallel ........................................................................................................................... 3738
ASCPerpendicular ................................................................................................................. 3738
ASCVertical ........................................................................................................................... 3738
BeamDiameter ...................................................................................................................... 3738
BeamPower .......................................................................................................................... 3738

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

BuildGasConvectionCoefficient ............................................................................................. 3739

BuildGasOrPowderTemperatureType ..................................................................................... 3739
BuildGasTemperature ........................................................................................................... 3739
BuildPowderConvectionCoefficient ....................................................................................... 3739
BuildPowderTemperature ..................................................................................................... 3739
Children ............................................................................................................................... 3739
Comments ............................................................................................................................ 3740
CooldownGasConvectionCoefficient ..................................................................................... 3740
CooldownGasOrPowderTemperatureType ............................................................................. 3740
CooldownGasTemperature ................................................................................................... 3740
CooldownPowderConvectionCoefficient ............................................................................... 3740
CooldownPowderTemperature ............................................................................................. 3740
DataModelObjectCategory ................................................................................................... 3741
DepositionThickness ............................................................................................................. 3741
DwellTime ............................................................................................................................ 3741
DwellTimeMultiple ............................................................................................................... 3741
Figures ................................................................................................................................. 3741
GeneratedLayerRotationAngle .............................................................................................. 3741
GeneratedStartLayerAngle .................................................................................................... 3742
HatchSpacing ....................................................................................................................... 3742
Images ................................................................................................................................. 3742
InherentStrain ....................................................................................................................... 3742
InherentStrainDefinition ....................................................................................................... 3742
InternalObject ...................................................................................................................... 3742
LayerHeightType ................................................................................................................... 3743
LayerHeightValue ................................................................................................................. 3743
NumberOfHeatSources ......................................................................................................... 3743
PowderPropertyFactor .......................................................................................................... 3743
PreheatTemperature ............................................................................................................. 3743
RoomTemperature ................................................................................................................ 3743
ScanPatternBuildFilePath ...................................................................................................... 3744
ScanPatternDefinition ........................................................................................................... 3744
ScanSpeed ............................................................................................................................ 3744
ScanStripeWidth ................................................................................................................... 3744
StrainScalingFactor ............................................................................................................... 3744
StrainScalingFactorX ............................................................................................................. 3744
StrainScalingFactorY ............................................................................................................. 3745
StrainScalingFactorZ ............................................................................................................. 3745
ThermalStrainMaterialModel ................................................................................................. 3745
ThermalStrainMethod ........................................................................................................... 3745
ThermalStrainScalingFactor ................................................................................................... 3745
AddComment() ..................................................................................................................... 3745
AddFigure() .......................................................................................................................... 3746
AddImage(string) .................................................................................................................. 3746
Delete() ................................................................................................................................ 3746
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3746
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3747
LoadBuildSettings(string) ...................................................................................................... 3747
ResetToDefault() ................................................................................................................... 3747
SaveBuildSettings(string) ...................................................................................................... 3748
AMProcess .................................................................................................................................. 3748

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

BaseGeometry ...................................................................................................................... 3749

BuildGeometry ..................................................................................................................... 3749
Children ............................................................................................................................... 3749
Comments ............................................................................................................................ 3750
DataModelObjectCategory ................................................................................................... 3750
ElementSize .......................................................................................................................... 3750
Figures ................................................................................................................................. 3750
HasAMStrains ....................................................................................................................... 3750
Images ................................................................................................................................. 3750
InternalObject ...................................................................................................................... 3751
LengthUnits .......................................................................................................................... 3751
MeshUsingVoxelization ......................................................................................................... 3751
NonlinearEffects ................................................................................................................... 3751
SubsampleRate ..................................................................................................................... 3751
WallThickness ....................................................................................................................... 3751
ZLocationAtTopOfBase ......................................................................................................... 3752
AddCartesianMesh() ............................................................................................................. 3752
AddComment() ..................................................................................................................... 3752
AddFigure() .......................................................................................................................... 3752
AddGeneratedAMSupport() .................................................................................................. 3752
AddImage(string) .................................................................................................................. 3752
AddPredefinedAMSupport() .................................................................................................. 3753
AddSTLAMSupport() ............................................................................................................. 3753
AddSupportGroup() .............................................................................................................. 3753
CleanAMStrains() .................................................................................................................. 3753
CreateBuildToBaseContact() .................................................................................................. 3753
Delete() ................................................................................................................................ 3754
GenerateAMStrains() ............................................................................................................. 3754
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3754
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3754
GetSequence(Analysis) ......................................................................................................... 3755
ResetAllSequences() .............................................................................................................. 3755
AMSupport ................................................................................................................................. 3755
Children ............................................................................................................................... 3756
Comments ............................................................................................................................ 3757
DataModelObjectCategory ................................................................................................... 3757
DensityMultiple .................................................................................................................... 3757
ElasticModulusMultipleInX .................................................................................................... 3757
ElasticModulusMultipleInY .................................................................................................... 3757
ElasticModulusMultipleInZ .................................................................................................... 3757
Figures ................................................................................................................................. 3758
Images ................................................................................................................................. 3758
InternalObject ...................................................................................................................... 3758
MaterialMultiplier ................................................................................................................. 3758
MultiplierEntry ...................................................................................................................... 3758
ShearModulusMultipleInXY ................................................................................................... 3758
ShearModulusMultipleInXZ ................................................................................................... 3759
ShearModulusMultipleInYZ ................................................................................................... 3759
SupportType ......................................................................................................................... 3759
ThermalConductivityMultipleInX ........................................................................................... 3759
ThermalConductivityMultipleInY ........................................................................................... 3759

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

ThermalConductivityMultipleInZ ........................................................................................... 3759

Volume ................................................................................................................................. 3760
WallSpacing .......................................................................................................................... 3760
WallThickness ....................................................................................................................... 3760
AddCommandSnippet() ........................................................................................................ 3760
AddComment() ..................................................................................................................... 3760
AddFigure() .......................................................................................................................... 3760
AddImage(string) .................................................................................................................. 3761
Delete() ................................................................................................................................ 3761
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3761
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3761
AMSupportGroup ....................................................................................................................... 3762
Children ............................................................................................................................... 3763
Comments ............................................................................................................................ 3763
DataModelObjectCategory ................................................................................................... 3763
DetectAboveZLocation ......................................................................................................... 3763
Figures ................................................................................................................................. 3764
GenerateOnRemesh .............................................................................................................. 3764
HangAngle ........................................................................................................................... 3764
Images ................................................................................................................................. 3764
InternalObject ...................................................................................................................... 3764
Location ............................................................................................................................... 3764
OutputType .......................................................................................................................... 3765
AddComment() ..................................................................................................................... 3765
AddFigure() .......................................................................................................................... 3765
AddGeneratedAMSupport() .................................................................................................. 3765
AddImage(string) .................................................................................................................. 3765
AddPredefinedAMSupport() .................................................................................................. 3766
AddSTLAMSupport() ............................................................................................................. 3766
Delete() ................................................................................................................................ 3766
DetectSupportFaces() ........................................................................................................... 3766
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3766
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3767
PromoteToNamedSelection() ................................................................................................ 3767
AMSupportRemovalSequence .................................................................................................... 3767
Count ................................................................................................................................... 3768
Add(IAMProcessStep) ............................................................................................................ 3768
Contains(IAMProcessStep) .................................................................................................... 3769
IndexOf(IAMProcessStep) ...................................................................................................... 3769
Insert(int, IAMProcessStep) .................................................................................................... 3769
RemoveAt(int) ...................................................................................................................... 3770
Swap(IAMProcessStep, IAMProcessStep) ................................................................................ 3770
Swap(int, int) ......................................................................................................................... 3771
BaseRemoval .............................................................................................................................. 3771
BuildStep .................................................................................................................................... 3771
CooldownStep ............................................................................................................................ 3771
GeneratedAMSupport ................................................................................................................. 3771
DataModelObjectCategory ................................................................................................... 3773
InternalObject ...................................................................................................................... 3773
Location ............................................................................................................................... 3774
Mode .................................................................................................................................... 3774

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

ClearGeneratedData() ........................................................................................................... 3774

CreateNamedSelectionOfGeneratedElements() ..................................................................... 3774
GenerateSupportBodies(Progress) ........................................................................................ 3774
HeatTreatmentStep ..................................................................................................................... 3775
IAMProcessStep .......................................................................................................................... 3775
ProcessStepType ................................................................................................................... 3775
PredefinedAMSupport ................................................................................................................ 3775
DataModelObjectCategory ................................................................................................... 3777
InternalObject ...................................................................................................................... 3777
Location ............................................................................................................................... 3777
Suppressed ........................................................................................................................... 3777
STLAMSupport ........................................................................................................................... 3777
DataModelObjectCategory ................................................................................................... 3780
ElementSize .......................................................................................................................... 3780
Filename .............................................................................................................................. 3780
GeometrySelection ............................................................................................................... 3780
InternalObject ...................................................................................................................... 3780
LengthUnits .......................................................................................................................... 3781
Source .................................................................................................................................. 3781
STL ....................................................................................................................................... 3781
STLSupportType ................................................................................................................... 3781
STLSupportView ................................................................................................................... 3781
StlWallThickness ................................................................................................................... 3781
SubsampleRate ..................................................................................................................... 3782
VoxelSize ***OBSOLETE*** Use 'ElementSize' property instead. .............................................. 3782
ClearGeneratedData() ........................................................................................................... 3782
CreateNamedSelectionOfExternalElementFaces() .................................................................. 3782
CreateNamedSelectionOfGeneratedElements() ..................................................................... 3782
ExportStl(string, Progress) ..................................................................................................... 3782
GenerateSupportBodies(Progress) ........................................................................................ 3783
GetGeneratedBody() ............................................................................................................. 3783
ImportSTL() .......................................................................................................................... 3783
SupportRemoval ......................................................................................................................... 3783
UserStep ..................................................................................................................................... 3784
Ansys.Mechanical.Selection Namespace ........................................................................................ 3785
GeometryRayCastHit ................................................................................................................... 3785
Entity .................................................................................................................................... 3785
HitVector .............................................................................................................................. 3785
GeometryRayCastSettings ........................................................................................................... 3786
GeometryRayCastSettings() .................................................................................................. 3786
CastLength ........................................................................................................................... 3786
CastRadius ............................................................................................................................ 3786
HitBodies .............................................................................................................................. 3787
HitEdges ............................................................................................................................... 3787
HitFaces ................................................................................................................................ 3787
HitVertices ............................................................................................................................ 3787
MaxHits ................................................................................................................................ 3787
SelectionHelper .......................................................................................................................... 3787
CastRayOnGeometry(BoundVector, GeometryRayCastSettings) ............................................. 3788
CreateVector3D(ISelectionInfo, bool) ..................................................................................... 3788
Ansys.Mechanical.Math Namespace .............................................................................................. 3791

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

BoundVector .............................................................................................................................. 3791

BoundVector(Point, Vector3D) ............................................................................................... 3791
Origin ................................................................................................................................... 3792
Vector ................................................................................................................................... 3792
Ansys.Mechanical.Application Namespace .................................................................................... 3793
Message ..................................................................................................................................... 3793
DisplayString ........................................................................................................................ 3793
Location ............................................................................................................................... 3794
RelatedObjects ..................................................................................................................... 3794
Severity ................................................................................................................................ 3794
Source .................................................................................................................................. 3794
StringID ................................................................................................................................ 3794
TimeStamp ........................................................................................................................... 3794
Messages .................................................................................................................................... 3795
Count ................................................................................................................................... 3795
Add(Message) ....................................................................................................................... 3795
Clear() ................................................................................................................................... 3795
Contains(Message) ................................................................................................................ 3796
Remove(Message) ................................................................................................................. 3796
ShowErrors() ......................................................................................................................... 3796
ObjectTag ................................................................................................................................... 3796
ObjectTag(string) .................................................................................................................. 3797
Name ................................................................................................................................... 3797
Objects ................................................................................................................................. 3797
AddObject(IDataModelObject) .............................................................................................. 3797
ClearObjects() ....................................................................................................................... 3798
RemoveObject(IDataModelObject) ........................................................................................ 3798
ObjectTags ................................................................................................................................. 3798
Count ................................................................................................................................... 3799
Item(int) ............................................................................................................................... 3799
Item(string) .......................................................................................................................... 3799
TagNames ............................................................................................................................ 3799
Add(ObjectTag) .................................................................................................................... 3799
Clear() ................................................................................................................................... 3800
Contains(ObjectTag) ............................................................................................................. 3800
GetTag(string) ....................................................................................................................... 3800
IndexOf(ObjectTag) ............................................................................................................... 3800
Remove(ObjectTag) .............................................................................................................. 3801
RemoveAt(int) ...................................................................................................................... 3801
Progress ..................................................................................................................................... 3801
SetProgress(uint, string, uint, string) ....................................................................................... 3802
Ansys.Mechanical.Table Namespace .............................................................................................. 3803
ColumnarDataImportDefinition .................................................................................................. 3803
ColumnarDataImportDefinition(int, VariableType, string, string) ............................................. 3804
Index .................................................................................................................................... 3804
Name ................................................................................................................................... 3804
Unit ...................................................................................................................................... 3804
VariableType ......................................................................................................................... 3805
DelimitedImportSettings ............................................................................................................ 3805
Delimiter .............................................................................................................................. 3805
FixedWidthImportSettings .......................................................................................................... 3805

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

ColumnWidths ...................................................................................................................... 3806

ImportHelpers ............................................................................................................................ 3806
ImportSettingsBase .................................................................................................................... 3806
Format ................................................................................................................................. 3807
ImportSettingsFactory ................................................................................................................ 3807
GetSettingsForFormat(ImportFormat) ................................................................................... 3807
Ansys.Mechanical.Graphics Namespace ........................................................................................ 3809
AnalysisSettingsGraph ................................................................................................................ 3809
BoundaryConditionVisibility ................................................................................................. 3809
AnimationExportSettings ............................................................................................................ 3810
AnimationExportSettings(int, int) .......................................................................................... 3810
Height .................................................................................................................................. 3810
Width ................................................................................................................................... 3810
AnnotationPreferences ............................................................................................................... 3811
PointMassSize ....................................................................................................................... 3811
ShowAllAnnotations ............................................................................................................. 3812
ShowBeams .......................................................................................................................... 3812
ShowBearings ....................................................................................................................... 3812
ShowBodyScopings .............................................................................................................. 3812
ShowCracks .......................................................................................................................... 3812
ShowCustomAnnotations ..................................................................................................... 3812
ShowElementNumbers ......................................................................................................... 3813
ShowForceArrows ................................................................................................................. 3813
ShowLabels .......................................................................................................................... 3813
ShowMeshAnnotations ......................................................................................................... 3813
ShowNamedSelectionElements ............................................................................................. 3813
ShowNodeNumbers .............................................................................................................. 3813
ShowPointMasses ................................................................................................................. 3814
ShowSprings ........................................................................................................................ 3814
SpringSize ............................................................................................................................ 3814
SetElementNumbering(int, int, int) ........................................................................................ 3814
SetNodeNumbering(int, int, int) ............................................................................................. 3815
GlobalLegendSettings ................................................................................................................ 3815
LegendOrientation ............................................................................................................... 3815
ShowDateAndTime ............................................................................................................... 3815
ShowDeformingScaling ........................................................................................................ 3816
ShowMinMax ........................................................................................................................ 3816
Graphics3DExportSettings .......................................................................................................... 3816
Graphics3DExportSettings() .................................................................................................. 3816
Background .......................................................................................................................... 3816
GraphicsImageExportSettings ..................................................................................................... 3817
GraphicsImageExportSettings() ............................................................................................. 3817
Background .......................................................................................................................... 3818
Capture ................................................................................................................................ 3818
CurrentGraphicsDisplay ........................................................................................................ 3818
FontMagnification ................................................................................................................ 3818
Height .................................................................................................................................. 3818
Resolution ............................................................................................................................ 3818
Width ................................................................................................................................... 3819
Point .......................................................................................................................................... 3819
Point(IList<object>, string) .................................................................................................... 3819

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

Location ............................................................................................................................... 3820

Unit ...................................................................................................................................... 3820
ConvertUnit(Point, string) ...................................................................................................... 3820
Equals(object) ....................................................................................................................... 3820
GetHashCode() ..................................................................................................................... 3821
op_Equality(Point, Point) ....................................................................................................... 3821
op_Inequality(Point, Point) .................................................................................................... 3821
ResultAnimationOptions ............................................................................................................. 3822
DisplacementTraces .............................................................................................................. 3822
Duration ............................................................................................................................... 3822
FitDeformationScalingToAnimation ...................................................................................... 3822
NumberOfFrames ................................................................................................................. 3823
RangeType ........................................................................................................................... 3823
TimeDecayCycles .................................................................................................................. 3823
UpdateContourRangeAtEachFrame ....................................................................................... 3823
ResultPreference ......................................................................................................................... 3823
CappingType ........................................................................................................................ 3824
ContourView ........................................................................................................................ 3824
DeformationScaleMultiplier .................................................................................................. 3824
DeformationScaling .............................................................................................................. 3824
ExtraModelDisplay ................................................................................................................ 3824
GeometryView ...................................................................................................................... 3825
IsoSurfaceValue .................................................................................................................... 3825
ScopingDisplay ..................................................................................................................... 3825
ShowMaximum .................................................................................................................... 3825
ShowMinimum ..................................................................................................................... 3825
SectionPlane ............................................................................................................................... 3825
SectionPlane() ...................................................................................................................... 3826
SectionPlane(Point, Vector3D, string, SectionPlaneType, bool) ................................................. 3826
Active ................................................................................................................................... 3827
Center .................................................................................................................................. 3827
Direction .............................................................................................................................. 3827
Name ................................................................................................................................... 3827
Type ..................................................................................................................................... 3827
Equals(SectionPlane) ............................................................................................................ 3828
SectionPlanes ............................................................................................................................. 3828
Capping ............................................................................................................................... 3828
Count ................................................................................................................................... 3829
ShowWholeElement ............................................................................................................. 3829
Add(SectionPlane) ................................................................................................................ 3829
Clear() ................................................................................................................................... 3829
Remove(SectionPlane) .......................................................................................................... 3829
RemoveAt(int) ...................................................................................................................... 3830
VectorDisplay ............................................................................................................................. 3830
ControlDisplayDensity .......................................................................................................... 3830
DisplayDensity ...................................................................................................................... 3831
DisplayType .......................................................................................................................... 3831
LengthMultiplier ................................................................................................................... 3831
LengthType .......................................................................................................................... 3831
ShowTriadXAxis .................................................................................................................... 3831
ShowTriadYAxis .................................................................................................................... 3831

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

ShowTriadZAxis .................................................................................................................... 3832

ViewOptions ............................................................................................................................... 3832
AnnotationPreferences ......................................................................................................... 3833
ClusteredVertexTolerance ..................................................................................................... 3833
ModelColoring ...................................................................................................................... 3833
ModelDisplay ........................................................................................................................ 3833
ResultPreference ................................................................................................................... 3833
ShowBeamThickness ............................................................................................................ 3834
ShowClusteredVertices ......................................................................................................... 3834
ShowCoordinateSystems ...................................................................................................... 3834
ShowEdgeDirection .............................................................................................................. 3834
ShowLegend ........................................................................................................................ 3834
ShowMesh ............................................................................................................................ 3834
ShowMeshConnection .......................................................................................................... 3835
ShowRandomColors ............................................................................................................. 3835
ShowRemotePointConnections ............................................................................................. 3835
ShowResultVectors ............................................................................................................... 3835
ShowRuler ............................................................................................................................ 3835
ShowShellThickness .............................................................................................................. 3835
ShowSPHExpansion .............................................................................................................. 3836
ShowThickEdgeScoping ........................................................................................................ 3836
ShowTriad ............................................................................................................................ 3836
ShowVertices ........................................................................................................................ 3836
VectorDisplay ....................................................................................................................... 3836
RescaleAnnotations() ............................................................................................................ 3836
Ansys.Mechanical.Graphics.Tools Namespace ............................................................................... 3837
CurrentLegendSettings ............................................................................................................... 3837
AllScientificNotation ............................................................................................................. 3838
ColorScheme ........................................................................................................................ 3838
Digits .................................................................................................................................... 3838
HighFidelity .......................................................................................................................... 3838
LogarithmicScale .................................................................................................................. 3839
NumberOfBands ................................................................................................................... 3839
SemiTransparency ................................................................................................................ 3839
GetBandColor(int) ................................................................................................................. 3839
GetBandColorAuto(int) ......................................................................................................... 3839
GetLowerBandValueAuto(int) ................................................................................................ 3840
GetLowerBound(int) ............................................................................................................. 3840
GetUpperBandValueAuto(int) ................................................................................................ 3840
GetUpperBound(int) ............................................................................................................. 3841
MakeCopy() .......................................................................................................................... 3841
Reset() .................................................................................................................................. 3841
ResetColors() ........................................................................................................................ 3841
SetBandColor(int, uint) .......................................................................................................... 3841
SetBandColorAuto(int, bool) .................................................................................................. 3842
SetLowerBound(int, Quantity) ............................................................................................... 3842
SetUpperBound(int, Quantity) ............................................................................................... 3842
LegendSettings .......................................................................................................................... 3843
AllScientificNotation ............................................................................................................. 3844
ColorScheme ........................................................................................................................ 3844
Digits .................................................................................................................................... 3844

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

HighFidelity .......................................................................................................................... 3844

LogarithmicScale .................................................................................................................. 3844
NumberOfBands ................................................................................................................... 3845
SemiTransparency ................................................................................................................ 3845
Unit ...................................................................................................................................... 3845
GetBandColor(int) ................................................................................................................. 3845
GetBandColorAuto(int) ......................................................................................................... 3845
GetLowerBandValueAuto(int) ................................................................................................ 3846
GetLowerBound(int) ............................................................................................................. 3846
GetUpperBandValueAuto(int) ................................................................................................ 3846
GetUpperBound(int) ............................................................................................................. 3847
Reset() .................................................................................................................................. 3847
ResetColors() ........................................................................................................................ 3847
SetBandColor(int, uint) .......................................................................................................... 3847
SetBandColorAuto(int, bool) .................................................................................................. 3848
SetLowerBound(int, Quantity) ............................................................................................... 3848
SetUpperBound(int, Quantity) ............................................................................................... 3848
Ansys.Mechanical.ExternalData Namespace ................................................................................. 3851
AXDTImportSettings ................................................................................................................... 3851
Dimension ............................................................................................................................ 3852
ColumnarDataImportDefinition .................................................................................................. 3852
ColumnarDataImportDefinition(int, VariableType, string, string, string) ................................... 3852
Index .................................................................................................................................... 3853
Name ................................................................................................................................... 3853
Unit ...................................................................................................................................... 3853
UserFieldVariable .................................................................................................................. 3854
VariableType ......................................................................................................................... 3854
DelimitedImportSettings ............................................................................................................ 3854
AverageCornerNodesToMidsideNodes .................................................................................. 3854
Delimiter .............................................................................................................................. 3855
ECADImportSettings ................................................................................................................... 3855
UseDummyNetData .............................................................................................................. 3855
ExternalDataFile .......................................................................................................................... 3855
ExternalDataFile(ImportSettingsBase, string, string, string, bool) ............................................. 3856
Description ........................................................................................................................... 3857
FilePath ................................................................................................................................ 3857
Identifier ............................................................................................................................... 3857
ImportSettings ..................................................................................................................... 3858
IsMainFile ............................................................................................................................. 3858
ExternalDataFileCollection .......................................................................................................... 3858
ExternalDataFileCollection(bool) ........................................................................................... 3859
Count ................................................................................................................................... 3859
Item(int) ............................................................................................................................... 3859
SaveFilesWithProject ............................................................................................................. 3860
Add(ExternalDataFile) ........................................................................................................... 3860
Clear() ................................................................................................................................... 3860
Contains(ExternalDataFile) .................................................................................................... 3860
CopyTo(ExternalDataFile[], int) ............................................................................................... 3860
GetEnumerator() ................................................................................................................... 3861
IndexOf(ExternalDataFile) ..................................................................................................... 3861
Insert(int, ExternalDataFile) ................................................................................................... 3861

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

Remove(ExternalDataFile) ..................................................................................................... 3862

RemoveAt(int) ...................................................................................................................... 3862
FixedWidthImportSettings .......................................................................................................... 3862
AverageCornerNodesToMidsideNodes .................................................................................. 3863
ColumnWidths ...................................................................................................................... 3864
ICEPAKImportSettings ................................................................................................................. 3864
SupportingFileDescription .................................................................................................... 3864
SupportingFileIdentifier ........................................................................................................ 3865
SupportingFilePath ............................................................................................................... 3865
ImportSettingsBase .................................................................................................................... 3865
Format ................................................................................................................................. 3865
ImportSettingsFactory ................................................................................................................ 3865
GetSettingsForFormat(ImportFormat) ................................................................................... 3866
MAPDLImportSettings ................................................................................................................ 3866
Dimension ............................................................................................................................ 3867
LengthUnit ........................................................................................................................... 3867
Ansys.Mechanical.DataModel.ConstructionLines Namespace ...................................................... 3869
ConstructionLineHelper .............................................................................................................. 3869
ClearExistingDataAndImportFromXML(ConstructionLine, string) ............................................ 3870
ExportToXML(ConstructionLine, string) .................................................................................. 3870
GetContainedEdges(Plane) ................................................................................................... 3871
GetEdgesById(ConstructionLine, IEnumerable<int>) .............................................................. 3871
GetEdgesUsingPoint(Point) ................................................................................................... 3871
GetEdgeVerticesById(ConstructionLine, IEnumerable<int>) ................................................... 3871
GetPlanesById(ConstructionLine, IEnumerable<int>) ............................................................. 3872
GetRelatedEdges(Plane) ........................................................................................................ 3872
Plane .......................................................................................................................................... 3873
Definition ............................................................................................................................. 3873
Normal ................................................................................................................................. 3873
Origin ................................................................................................................................... 3873
PrimaryAxisDirection ............................................................................................................ 3874
SecondaryAxisDirection ........................................................................................................ 3874
Type ..................................................................................................................................... 3874
Equivalent(Plane) .................................................................................................................. 3874
PlaneType ................................................................................................................................... 3874
Point .......................................................................................................................................... 3875
Definition ............................................................................................................................. 3875
Location ............................................................................................................................... 3875
Type ..................................................................................................................................... 3875
Equivalent(Point) .................................................................................................................. 3875
Point2DPlanar ............................................................................................................................. 3876
Point2DPlanar(Point2DPlanar) ............................................................................................... 3876
Point2DPlanar(Point2D, Plane) ............................................................................................... 3876
Location ............................................................................................................................... 3877
Plane .................................................................................................................................... 3877
GetGlobalLocation(Point2DPlanar) ........................................................................................ 3877
PointType ................................................................................................................................... 3877
Ansys.Mechanical.DataModel.ConstructionLines.Edges Namespace ........................................... 3879
IEdge .......................................................................................................................................... 3879
Length .................................................................................................................................. 3879
StraightLineEdge ........................................................................................................................ 3879

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

EndPoint ............................................................................................................................... 3880

Length .................................................................................................................................. 3880
StartPoint ............................................................................................................................. 3880
Ansys.Mechanical.Interfaces Namespace ....................................................................................... 3881
IDataSeries ................................................................................................................................. 3881
DataType .............................................................................................................................. 3881
Name ................................................................................................................................... 3882
QuantityName ...................................................................................................................... 3882
Unit ...................................................................................................................................... 3882
Values ................................................................................................................................... 3882
IDataTable .................................................................................................................................. 3882
ColumnNames ...................................................................................................................... 3883
Columns ............................................................................................................................... 3883
Count ................................................................................................................................... 3884
IsFixedColumnCount ............................................................................................................. 3884
IsFixedRowCount .................................................................................................................. 3884
IsReadOnly ........................................................................................................................... 3884
Item(object) .......................................................................................................................... 3884
Metadata .............................................................................................................................. 3885
Name ................................................................................................................................... 3885
RowCount ............................................................................................................................ 3885
Add(IDataSeries) ................................................................................................................... 3885
Clear() ................................................................................................................................... 3885
Contains(string) .................................................................................................................... 3886
GetRow(int) .......................................................................................................................... 3886
Insert(int, IDataSeries) ........................................................................................................... 3886
Remove(object) .................................................................................................................... 3886
TryInsertRow(int, IEnumerable) .............................................................................................. 3887
TryRemoveRow(int) .............................................................................................................. 3887
IReadOnlyDataSeries ................................................................................................................... 3887
Count ................................................................................................................................... 3888
DataType .............................................................................................................................. 3888
Item(int) ............................................................................................................................... 3888
Name ................................................................................................................................... 3888
QuantityName ...................................................................................................................... 3889
Unit ...................................................................................................................................... 3889
Values ................................................................................................................................... 3889
IReadOnlyDataTable ................................................................................................................... 3889
ColumnNames ...................................................................................................................... 3890
Columns ............................................................................................................................... 3890
Item(object) .......................................................................................................................... 3890
Metadata .............................................................................................................................. 3890
Name ................................................................................................................................... 3890
RowCount ............................................................................................................................ 3890
GetRow(int) .......................................................................................................................... 3891
ITable ......................................................................................................................................... 3891
Dependents .......................................................................................................................... 3891
Independents ....................................................................................................................... 3891
IVariable ..................................................................................................................................... 3892
QuantityName ...................................................................................................................... 3892
Unit ...................................................................................................................................... 3892

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

Ansys.Mechanical.DataModel.Utilities Namespace ....................................................................... 3893

BeamCoordinateSystem .............................................................................................................. 3893
RigidBodyTransformationMatrix .................................................................................................. 3893
Data ..................................................................................................................................... 3894
S ........................................................................................................................................... 3894
T_x ....................................................................................................................................... 3895
T_y ....................................................................................................................................... 3895
T_z ....................................................................................................................................... 3895
tau_x .................................................................................................................................... 3895
tau_y .................................................................................................................................... 3895
tau_z .................................................................................................................................... 3895
X_x ....................................................................................................................................... 3896
X_y ....................................................................................................................................... 3896
X_z ....................................................................................................................................... 3896
Y_x ....................................................................................................................................... 3896
Y_y ....................................................................................................................................... 3896
Y_z ....................................................................................................................................... 3896
Z_x ....................................................................................................................................... 3897
Z_y ....................................................................................................................................... 3897
Z_z ....................................................................................................................................... 3897
Ansys.Mechanical.DataModel.Utilities.TabularData Namespace .................................................. 3899
DataSeriesAdapter ...................................................................................................................... 3899
DataSeriesAdapter(object, bool) ............................................................................................ 3900
PropertyChanged ................................................................................................................. 3900
Count ................................................................................................................................... 3900
DataType .............................................................................................................................. 3901
IsFixedSize ............................................................................................................................ 3901
IsReadOnly ........................................................................................................................... 3901
IsSynchronized ..................................................................................................................... 3901
Item(int) ............................................................................................................................... 3901
Name ................................................................................................................................... 3901
QuantityName ...................................................................................................................... 3902
SyncRoot .............................................................................................................................. 3902
Unit ...................................................................................................................................... 3902
Values ................................................................................................................................... 3902
Add(object) .......................................................................................................................... 3902
Clear() ................................................................................................................................... 3903
Contains(object) ................................................................................................................... 3903
CopyTo(Array, int) .................................................................................................................. 3903
GetEnumerator() ................................................................................................................... 3903
IndexOf(object) .................................................................................................................... 3904
Insert(int, object) ................................................................................................................... 3904
Remove(object) .................................................................................................................... 3904
RemoveAt(int) ...................................................................................................................... 3905
ReadOnlyDataSeriesAdapter ....................................................................................................... 3905
ReadOnlyDataSeriesAdapter(object) ..................................................................................... 3905
Count ................................................................................................................................... 3906
DataType .............................................................................................................................. 3906
Item(int) ............................................................................................................................... 3906
Name ................................................................................................................................... 3906
QuantityName ...................................................................................................................... 3906

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

Unit ...................................................................................................................................... 3907

Values ................................................................................................................................... 3907
GetEnumerator() ................................................................................................................... 3907
ReadOnlyDataTableAdapter ........................................................................................................ 3907
ReadOnlyDataTableAdapter(IDataTable) ................................................................................ 3908
ColumnNames ...................................................................................................................... 3908
Columns ............................................................................................................................... 3908
Count ................................................................................................................................... 3908
Item(object) .......................................................................................................................... 3909
Metadata .............................................................................................................................. 3909
Name ................................................................................................................................... 3909
RowCount ............................................................................................................................ 3909
GetEnumerator() ................................................................................................................... 3909
GetRow(int) .......................................................................................................................... 3910
Ansys.Mechanical.DataModel.SolverData Namespace .................................................................. 3911
MAPDLAMSupportData .............................................................................................................. 3912
MaterialIds ............................................................................................................................ 3912
RealConstantId ..................................................................................................................... 3912
MAPDLBeamData ....................................................................................................................... 3912
MaterialId ............................................................................................................................. 3912
MAPDLBearingData .................................................................................................................... 3913
MAPDLBodyData ........................................................................................................................ 3913
ElementTypeIds .................................................................................................................... 3913
MaterialIds ............................................................................................................................ 3913
RealConstantId ..................................................................................................................... 3913
MAPDLBoltPretensionData .......................................................................................................... 3914
PretensionNodeIds ............................................................................................................... 3914
RealConstantIds .................................................................................................................... 3914
MAPDLContactData .................................................................................................................... 3914
SourceId ............................................................................................................................... 3915
TargetId ................................................................................................................................ 3915
MAPDLCoordinateSystemData .................................................................................................... 3915
SystemId .............................................................................................................................. 3915
MAPDLImportedSurfaceLoadData ............................................................................................... 3915
LoadTypes ............................................................................................................................ 3916
GetSurfaceEffectElementTypeId(ImportedSurfaceLoadType) ................................................. 3916
MAPDLJointData ........................................................................................................................ 3916
MAPDLLayeredSectionData ........................................................................................................ 3916
SectionId .............................................................................................................................. 3917
MAPDLRemotePointData ............................................................................................................ 3917
NodeId ................................................................................................................................. 3917
MAPDLSolverData ...................................................................................................................... 3917
MaxElementId ...................................................................................................................... 3918
MaxElementTypeId ............................................................................................................... 3918
MaxNodeId ........................................................................................................................... 3918
ElementIdsByMaterialId(string) ............................................................................................. 3918
NodeIdsByMaterialId(string) .................................................................................................. 3919
MAPDLSpringData ...................................................................................................................... 3919
MAPDLSurfaceCoatingData ......................................................................................................... 3919
MaterialId ............................................................................................................................. 3919
MAPDLSurfaceLoadData ............................................................................................................. 3920

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

SurfaceEffectElementTypeId ................................................................................................. 3920

SolverData .................................................................................................................................. 3920
GetObjectData(IDataModelObject) ....................................................................................... 3920
Ansys.Mechanical.DataModel.Results Namespace ........................................................................ 3921
ResultDataTable .......................................................................................................................... 3921
Count ................................................................................................................................... 3921
Item(string) .......................................................................................................................... 3922
Keys ..................................................................................................................................... 3922
Values ................................................................................................................................... 3922
ContainsKey(string) ............................................................................................................... 3922
ResultVariable ............................................................................................................................. 3922
Count ................................................................................................................................... 3923
Item(int) ............................................................................................................................... 3923
Ansys.Mechanical.DataModel.MechanicalEnums.Table Namespace ............................................. 3925
ImportFormat ............................................................................................................................. 3925
VariableType ............................................................................................................................... 3925
Ansys.Mechanical.DataModel.MechanicalEnums.ExternalData Namespace ................................ 3927
ImportFormat ............................................................................................................................. 3927
Length ........................................................................................................................................ 3927
VariableType ............................................................................................................................... 3928
Ansys.Mechanical.DataModel.MechanicalEnums.Graphics Namespace ....................................... 3931
CappingType .............................................................................................................................. 3931
ContourView .............................................................................................................................. 3931
DeformationScaling .................................................................................................................... 3932
ExtraModelDisplay ...................................................................................................................... 3932
GeometryView ............................................................................................................................ 3932
ScopingDisplay ........................................................................................................................... 3933
Ansys.Mechanical.DataModel.Enums Namespace ......................................................................... 3935
ActiveOrInactive ......................................................................................................................... 3950
AggressiveRemeshingType ......................................................................................................... 3950
AMCooldownTimeType ............................................................................................................... 3950
AMInherentStrainDefinition ........................................................................................................ 3950
AMLayerHeightType ................................................................................................................... 3951
AMMultiplierEntryType ............................................................................................................... 3951
AMProcessSettingsType .............................................................................................................. 3951
AMProcessSimulationType .......................................................................................................... 3952
AMProcessStepType .................................................................................................................... 3952
AMProcessType .......................................................................................................................... 3952
AMReferenceTemperatureType ................................................................................................... 3953
AMRelaxationTemperatureType .................................................................................................. 3953
AMScanPatternDefinition ............................................................................................................ 3953
AMStlSource ............................................................................................................................... 3954
AMSupportGroupOutputType ..................................................................................................... 3954
AMSupportSTLType .................................................................................................................... 3954
AMSupportType ......................................................................................................................... 3954
AMThermalStrainMaterialModel .................................................................................................. 3955
AMThermalStrainMethod ............................................................................................................ 3955
AnalysisType ............................................................................................................................... 3955
ApplicationType ......................................................................................................................... 3956
ArtificiallyMatchedLayers ............................................................................................................ 3956
AutoDetectionType ..................................................................................................................... 3957

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

AutomaticOrManual ................................................................................................................... 3957

AutomaticTimeStepping ............................................................................................................. 3957
AxisSelectionType ....................................................................................................................... 3957
BaseResultType ........................................................................................................................... 3958
BeamBeamContactDetectionType ............................................................................................... 3958
BeamBeamModel ....................................................................................................................... 3959
BeamEndReleaseBehavior ........................................................................................................... 3959
BeamOffsetType ......................................................................................................................... 3959
BeamSolutionType ...................................................................................................................... 3959
BeamToolStressResultType .......................................................................................................... 3960
BodyInteractionFormulation ....................................................................................................... 3960
BodyTreatment ........................................................................................................................... 3960
BodyType ................................................................................................................................... 3961
BoltLoadDefineBy ....................................................................................................................... 3961
BoltResultType ............................................................................................................................ 3961
BondedBreakableType ................................................................................................................ 3962
BoundaryConditionAlongFiber ................................................................................................... 3962
BoundaryConditionForRotation .................................................................................................. 3962
BoundaryConditionSelectionType ............................................................................................... 3963
BoundaryConditionType ............................................................................................................. 3963
BrickIntegrationScheme .............................................................................................................. 3963
CacheResultsInMemory .............................................................................................................. 3964
CalculateParticipationFactorResult .............................................................................................. 3964
CameraAxisType ......................................................................................................................... 3964
CampbellDiagramRotationalVelocitySelectionType ..................................................................... 3965
ChartAxisScaleType ..................................................................................................................... 3965
ChartDimensions ........................................................................................................................ 3966
ChartGridlines ............................................................................................................................ 3966
ChartModalType ......................................................................................................................... 3966
ChartPlotStyle ............................................................................................................................. 3966
ChartReportType ........................................................................................................................ 3967
ChartResultType ......................................................................................................................... 3967
ChartScale .................................................................................................................................. 3968
CombineRestartFilesType ............................................................................................................ 3968
CommandEditorTarget ................................................................................................................ 3968
ComparePartsOnUpdateType ...................................................................................................... 3969
ComparePartsToleranceType ....................................................................................................... 3969
CondensedPartCMSAttachmentMethod ...................................................................................... 3969
CondensedPartExpansionType .................................................................................................... 3970
CondensedPartFileFormat ........................................................................................................... 3970
CondensedPartInterfaceMethod ................................................................................................. 3970
CondensedPartInterfaceType ...................................................................................................... 3971
CondensedPartKeepFilesFor ........................................................................................................ 3971
CondensedPartLumpedMassFormulation .................................................................................... 3971
CondensedPartPhysics ................................................................................................................ 3972
CondensedPartPointMassTreatment ............................................................................................ 3972
CondensedPartReductionMethod ............................................................................................... 3972
ConnectionCreationMethod ....................................................................................................... 3973
ConnectionOptions .................................................................................................................... 3973
ConnectionScopingType ............................................................................................................. 3973
ConstantDampingType ............................................................................................................... 3973

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

ContactBehavior ......................................................................................................................... 3974

ContactBoltThreadHand ............................................................................................................. 3974
ContactBoltThreadType .............................................................................................................. 3974
ContactConstraintType ............................................................................................................... 3975
ContactCorrection ...................................................................................................................... 3975
ContactDetection ....................................................................................................................... 3975
ContactDetectionPoint ............................................................................................................... 3976
ContactEdgeEdgeOption ............................................................................................................ 3976
ContactElasticSlipToleranceType ................................................................................................. 3976
ContactFaceEdgeOption ............................................................................................................. 3977
ContactFaceEdgePriority ............................................................................................................. 3977
ContactForceType ....................................................................................................................... 3977
ContactFormulation .................................................................................................................... 3978
ContactGroupingType ................................................................................................................ 3978
ContactInitialEffect ..................................................................................................................... 3979
ContactOrientation ..................................................................................................................... 3979
ContactPenetrationToleranceType ............................................................................................... 3979
ContactPinballType ..................................................................................................................... 3980
ContactResultType ...................................................................................................................... 3980
ContactScopingType ................................................................................................................... 3980
ContactSearchingType ................................................................................................................ 3981
ContactSideScopingType ............................................................................................................ 3981
ContactSmallSlidingType ............................................................................................................ 3981
ContactSplitType ........................................................................................................................ 3982
ContactSummaryType ................................................................................................................ 3982
ContactTimeStepControls ........................................................................................................... 3982
ContactToleranceType ................................................................................................................ 3982
ContactTrimType ........................................................................................................................ 3983
ContactType ............................................................................................................................... 3983
ConvectionTableSelection ........................................................................................................... 3984
ConvergenceControlType ............................................................................................................ 3984
ConvergenceToleranceType ........................................................................................................ 3984
ConvergenceType ....................................................................................................................... 3984
CoordinateSystemAlignmentType ............................................................................................... 3985
CoordinateSystemAxisType ......................................................................................................... 3985
CoordinateSystemBehavior ......................................................................................................... 3986
CoordinateSystemType ............................................................................................................... 3986
CoreResultType ........................................................................................................................... 3986
CouplingConditionDOFType ....................................................................................................... 3987
CrackGrowthIncrementType ....................................................................................................... 3987
CrackGrowthMethodology .......................................................................................................... 3987
CrackGrowthOption .................................................................................................................... 3988
CrackMeshMethod ...................................................................................................................... 3988
CrackSelectionModeType ............................................................................................................ 3988
CrackShapeType ......................................................................................................................... 3988
CrackSourceType ........................................................................................................................ 3989
Creep ......................................................................................................................................... 3989
CrossSectionType ....................................................................................................................... 3989
CyclicHarmonicIndex .................................................................................................................. 3990
CylindricalFacesOption ............................................................................................................... 3990
DamageResultType ..................................................................................................................... 3991

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

DampingDefineBy ...................................................................................................................... 3991

DampingType ............................................................................................................................. 3991
DataImportStatus ....................................................................................................................... 3992
DataModelObjectCategory ......................................................................................................... 3992
DataTypeOptions ........................................................................................................................ 4011
DeformationType ***OBSOLETE*** Use 'TotalOrDirectional' property instead. .............................. 4011
DelaminationFailureCriteriaOption .............................................................................................. 4011
DelaminationGenerationMethod ................................................................................................ 4012
DelaminationMethod .................................................................................................................. 4012
DelaminationType ...................................................................................................................... 4012
DiagonalOrConsistent ................................................................................................................. 4013
DistributedMassInputType .......................................................................................................... 4013
DpfEvaluationType ..................................................................................................................... 4013
DropDirection ............................................................................................................................. 4013
DropTestDefineBy ....................................................................................................................... 4014
DSCampbellAxisRange ................................................................................................................ 4014
DSCampbellYAxisDataType ......................................................................................................... 4014
DSRBDContactDetection ............................................................................................................. 4015
DynamicRelaxationBehaviorType ................................................................................................ 4015
ECADFidelity ............................................................................................................................... 4015
EdgeContactType ....................................................................................................................... 4016
EdgeType ................................................................................................................................... 4016
EigenSolverType ......................................................................................................................... 4017
ElectricType ................................................................................................................................ 4017
ElementControl .......................................................................................................................... 4017
ElementControlsNormalStiffnessType .......................................................................................... 4018
ElementControlsStatus ................................................................................................................ 4018
ElementMidsideNodesType ......................................................................................................... 4018
ElementMorphingType ............................................................................................................... 4019
ElementOrder ............................................................................................................................. 4019
ElementOrientationAxisType ....................................................................................................... 4019
ElementOrientationGuide ........................................................................................................... 4020
EnclosureType ............................................................................................................................ 4020
EquationSolverType .................................................................................................................... 4020
ExcitationType ............................................................................................................................ 4021
ExclusionParticipantType ............................................................................................................ 4021
EXDADRConvergenceMethod ..................................................................................................... 4021
EXDArtificialViscosityForShellsType ............................................................................................. 4022
EXDAutomaticMassScalingType .................................................................................................. 4022
EXDBeamSolutionType ............................................................................................................... 4022
EXDCharZoneDimensionType ..................................................................................................... 4023
EXDDensityUpdateType .............................................................................................................. 4023
EXDDetonationBurnType ............................................................................................................ 4023
EXDErosionOnGeomStrainType ................................................................................................... 4024
EXDErosionOnMaterialFailureType .............................................................................................. 4024
EXDErosionOnMinElemTimestepType ......................................................................................... 4024
EXDErosionRetainIntertiaType ..................................................................................................... 4025
EXDEulerBoundaryDefType ......................................................................................................... 4025
EXDEulerDomainType ................................................................................................................. 4025
EXDEulerDomScopeDefType ....................................................................................................... 4026
EXDEulerGradedDefinition .......................................................................................................... 4026

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

EXDEulerResolutionDefType ....................................................................................................... 4026

EXDEulerSizeDefType .................................................................................................................. 4027
EXDEulerTrackType ..................................................................................................................... 4027
EXDHexIntegrationType .............................................................................................................. 4027
EXDHourglassDampingType ....................................................................................................... 4028
EXDLinearViscosityExpansionType .............................................................................................. 4028
EXDLoadStepType ...................................................................................................................... 4028
EXDOutputContactForcesOnType ............................................................................................... 4029
EXDPreferenceType .................................................................................................................... 4029
EXDSavePrintSummaryOnType ................................................................................................... 4030
EXDSaveProbeDataOnType ......................................................................................................... 4030
EXDSaveRestartsOnType ............................................................................................................. 4030
EXDSaveResultsOnType .............................................................................................................. 4031
EXDSaveUserEditOnType ............................................................................................................ 4031
EXDShellInertiaUpdateType ........................................................................................................ 4031
EXDShellThicknessUpdateType ................................................................................................... 4032
EXDShellWarpCorrectionType ..................................................................................................... 4032
EXDSolverPrecisionType .............................................................................................................. 4032
EXDSolveUnitsType ..................................................................................................................... 4033
EXDSPHNodeDensityCutoffOption .............................................................................................. 4033
EXDStepawareOutputControlsType ............................................................................................. 4033
EXDTetPressureIntegrationType .................................................................................................. 4034
ExpandResultFrom ...................................................................................................................... 4034
ExpandResultsSubType ............................................................................................................... 4034
ExportTopologyFileOption .......................................................................................................... 4035
ExternalEnhancedModelType ...................................................................................................... 4035
ExternalLoadApplicationType ..................................................................................................... 4035
ExternalLoadDefineActiveSequenceBy ........................................................................................ 4035
ExternalLoadDisplacementType .................................................................................................. 4036
ExternalLoadDisplayComponentType .......................................................................................... 4036
ExternalLoadDisplayDataType ..................................................................................................... 4037
ExtrudeBy ................................................................................................................................... 4037
FaceMeshingMethod .................................................................................................................. 4038
FaceType .................................................................................................................................... 4038
FarFieldMicrophoneDefinitionMethodType ................................................................................. 4038
FarFieldRadiationSurfaceType ..................................................................................................... 4039
FatigueAnalysisType ................................................................................................................... 4039
FatigueFrequencySelection ......................................................................................................... 4039
FatigueLoadType ........................................................................................................................ 4040
FatigueSensitivityType ................................................................................................................ 4040
FatigueStressComponentType .................................................................................................... 4040
FatigueToolAnalysisType ............................................................................................................. 4041
FatigueToolMethod .................................................................................................................... 4041
FatigueToolResultsInputType ...................................................................................................... 4041
FeatureSuppressMethod ............................................................................................................. 4042
FEConnectionDisplay .................................................................................................................. 4042
FEConnectionDisplayType ........................................................................................................... 4042
FEConnectionLineColor .............................................................................................................. 4043
FEConnectionLineThicknessType ................................................................................................ 4043
FilterType ................................................................................................................................... 4043
FittingMethodType ..................................................................................................................... 4043

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

FixedOrFree ................................................................................................................................ 4044

FluentExportMeshType ............................................................................................................... 4044
FluidBehavior ............................................................................................................................. 4044
FluidDiscretizationType ............................................................................................................... 4045
ForceComponentSelectionType .................................................................................................. 4045
FormulationType ........................................................................................................................ 4045
FractureAffectedZone ................................................................................................................. 4046
FractureSIFSProbeSubType ......................................................................................................... 4046
FrequencyRangeType ................................................................................................................. 4046
FrequencySpacingType ............................................................................................................... 4046
FutureIntentType ........................................................................................................................ 4047
GapDefinedBy ............................................................................................................................ 4047
GapDensityType ......................................................................................................................... 4048
GAPDirectionType ...................................................................................................................... 4048
GasketResultType ....................................................................................................................... 4048
GeneralMiscellaneousOptionType ............................................................................................... 4049
GeometryDefineByType .............................................................................................................. 4049
GeometryDimensionType ........................................................................................................... 4050
GeometryType ............................................................................................................................ 4050
GPUAccelerationDevicesType ...................................................................................................... 4051
GraphControlsXAxis .................................................................................................................... 4051
Graphics3DExportFormat ............................................................................................................ 4051
GraphicsAnimationExportFormat ................................................................................................ 4052
GraphicsBackgroundType ........................................................................................................... 4052
GraphicsCaptureType ................................................................................................................. 4052
GraphicsImageExportFormat ...................................................................................................... 4053
GraphicsResolutionType ............................................................................................................. 4053
GravityOrientationType ............................................................................................................... 4053
GrowElbowElementsBy ............................................................................................................... 4054
HarmonicMethod ....................................................................................................................... 4054
HarmonicMSUPStorage ............................................................................................................... 4054
HarmonicMultiStepType ............................................................................................................. 4055
HarmonicVariationalTechnology ................................................................................................. 4055
HexIntegrationType .................................................................................................................... 4055
HourglassDampingType .............................................................................................................. 4055
ICEMCFDBehavior ....................................................................................................................... 4056
ImportedCondensedPartStatus ................................................................................................... 4056
ImportedLoadType ..................................................................................................................... 4056
ImportParameterType ................................................................................................................. 4057
IncidentWaveLocation ................................................................................................................ 4058
InitialClearanceType .................................................................................................................... 4058
InitialConditionsType .................................................................................................................. 4058
InitializationModifierType ........................................................................................................... 4059
InitialTemperatureType ............................................................................................................... 4059
InterpolationType ....................................................................................................................... 4059
IterationOptions ......................................................................................................................... 4059
JointConditionType .................................................................................................................... 4060
JointFormulation ........................................................................................................................ 4060
JointFrictionType ........................................................................................................................ 4061
JointGeneralPrimitiveType .......................................................................................................... 4061
JointInitialPosition ...................................................................................................................... 4061

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

JointRotationDOFType ................................................................................................................ 4061

JointScopingType ....................................................................................................................... 4062
JointSolverElementType .............................................................................................................. 4062
JointStopType ............................................................................................................................. 4062
JointType .................................................................................................................................... 4063
KinematicDOF ............................................................................................................................ 4063
KrigingCorrFuncType .................................................................................................................. 4064
KrigingPolynomType .................................................................................................................. 4064
LatticeType ................................................................................................................................. 4065
LegendColorSchemeType ........................................................................................................... 4065
LegendOrientationType .............................................................................................................. 4066
LegendRangeType ...................................................................................................................... 4066
LifeUnitsType .............................................................................................................................. 4067
LimitBCDirection ........................................................................................................................ 4067
Linearized2DBehavior ................................................................................................................. 4067
LinearizedSubtype ...................................................................................................................... 4068
LinePressureResultBasedOnType ................................................................................................. 4068
LineSearchType .......................................................................................................................... 4068
LoadAppliedBy ........................................................................................................................... 4069
LoadBehavior ............................................................................................................................. 4069
LoadCombinationType ................................................................................................................ 4069
LoadDefineBy ............................................................................................................................. 4070
LoadedArea ................................................................................................................................ 4070
LoadingApplicationType ............................................................................................................. 4070
LoadVariableVariationType .......................................................................................................... 4071
LoadVariationSubOption ............................................................................................................. 4075
LoadVariationType ...................................................................................................................... 4076
LocationDefinitionMethod .......................................................................................................... 4076
LowReducedFrequencyModelType ............................................................................................. 4077
ManualContactTreatmentType .................................................................................................... 4077
ManufacturingConstraintSubtype ............................................................................................... 4077
ManuMemberSizeControlledType ............................................................................................... 4078
MappingAlgorithm ..................................................................................................................... 4078
MappingControlType .................................................................................................................. 4078
MappingInterpolationType ......................................................................................................... 4079
MappingIsolineLineType ............................................................................................................. 4079
MappingIsolineThicknessType .................................................................................................... 4079
MappingMethod ........................................................................................................................ 4080
MappingOutsideOption .............................................................................................................. 4080
MappingValidationDisplayOption ............................................................................................... 4081
MappingValidationType .............................................................................................................. 4081
MappingVariableType ................................................................................................................. 4082
MeanStressTheoryType ............................................................................................................... 4083
MeshControlGroupRigidBodyBehaviorType ................................................................................. 4083
MeshControlGroupRigidBodyFaceMeshType ............................................................................... 4084
MeshControlPinchGeomtryType ................................................................................................. 4084
MeshDisplayStyle ........................................................................................................................ 4084
MeshElementShape .................................................................................................................... 4085
MeshMethodAlgorithm .............................................................................................................. 4086
MeshMetricType ......................................................................................................................... 4086
MeshNodeType .......................................................................................................................... 4087

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

MeshPhysicsPreferenceType ....................................................................................................... 4087

MeshRestartControlsType ........................................................................................................... 4088
MeshRestartRetainFilesType ........................................................................................................ 4088
MeshRestartSaveAtLoadStep ...................................................................................................... 4088
MeshRestartSaveAtSubstep ........................................................................................................ 4088
MeshSolverPreferenceType ......................................................................................................... 4089
MeshSourceType ........................................................................................................................ 4089
MessageSeverityType ................................................................................................................. 4089
MethodType ............................................................................................................................... 4090
MinimumOrMaximum ................................................................................................................ 4090
ModalFrequencyRangeType ........................................................................................................ 4091
Model2DBehavior ....................................................................................................................... 4091
ModelColoring ............................................................................................................................ 4091
ModelDisplay .............................................................................................................................. 4092
ModelType ................................................................................................................................. 4092
ModesCombinationType ............................................................................................................. 4093
MomentsAtSummationPointType ............................................................................................... 4093
MPIType ..................................................................................................................................... 4093
MultipleNodeType ...................................................................................................................... 4094
NamedSelectionWorksheetOperator ........................................................................................... 4094
NewtonRaphsonType .................................................................................................................. 4094
NLADControlProjectToGeometry ................................................................................................. 4095
NodalPlanesVisible ..................................................................................................................... 4095
NodeMoveInformationType ........................................................................................................ 4095
NodeSelection ............................................................................................................................ 4095
NonCyclicLoadingType ............................................................................................................... 4096
NonlinearAdaptivityControlsRefinementAlgorithmType .............................................................. 4096
NonlinearAdaptivityControlsRemeshingGradientType ................................................................. 4096
NonlinearAdaptivityCriterionType ............................................................................................... 4097
NonlinearAdaptivityOptionType .................................................................................................. 4097
NonlinearAdaptivityTimeRange .................................................................................................. 4097
NonlinearAdaptivityUpdateType ................................................................................................. 4098
NonLinearFormulationType ......................................................................................................... 4098
NonLinearValueType ................................................................................................................... 4098
NormalOrientationType .............................................................................................................. 4098
ObjectiveType ............................................................................................................................ 4099
ObjectState ................................................................................................................................ 4099
OptimizationResponseConstraintComponentType ...................................................................... 4100
OptimizationSolverType .............................................................................................................. 4100
OptimizationType ....................................................................................................................... 4101
OutputControlsNodalForcesType ................................................................................................ 4101
PartTransformationDefinitionType .............................................................................................. 4101
PassFailResult ............................................................................................................................. 4102
PatchIndependentDefineType ..................................................................................................... 4102
PathScopingType ........................................................................................................................ 4102
PeriodicApplyTo ......................................................................................................................... 4103
PeriodicityDirectionType ............................................................................................................. 4103
PeriodicRegionType .................................................................................................................... 4103
PFactorResultType ...................................................................................................................... 4104
PhaseType .................................................................................................................................. 4104
PhysicsType ................................................................................................................................ 4104

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

PilotNodeScopingType ............................................................................................................... 4105

PinBehavior ................................................................................................................................ 4105
PinNature ................................................................................................................................... 4106
PipeLoadingType ........................................................................................................................ 4106
PMLOptions ................................................................................................................................ 4106
PolyflowExportUnit ..................................................................................................................... 4106
PortAttribution ........................................................................................................................... 4107
PortBehavior ............................................................................................................................... 4107
PortPosition ................................................................................................................................ 4107
PressureAtZeroPenetrationType .................................................................................................. 4108
PressureInitializationType ........................................................................................................... 4108
PreStressContactStatus ............................................................................................................... 4108
PreStressLoadControl .................................................................................................................. 4108
PreStressMode ............................................................................................................................ 4109
PreStressStateType ..................................................................................................................... 4109
ProbeDisplayFilter ....................................................................................................................... 4109
ProbeExtractionType ................................................................................................................... 4111
ProbeResultType ......................................................................................................................... 4111
PrototypeDisplayStyleType ......................................................................................................... 4113
PrototypeLinkBehavior ............................................................................................................... 4113
PrototypeModelType .................................................................................................................. 4114
ProximitySFSourcesType ............................................................................................................. 4114
PSDBoundaryConditionSelectionType ......................................................................................... 4115
PullMethod ................................................................................................................................. 4115
PullOutConstraintSubtype .......................................................................................................... 4115
PullOutDirectionType .................................................................................................................. 4116
PythonCodeTargetCallback ......................................................................................................... 4116
RadiationType ............................................................................................................................. 4117
RadiositySolverType .................................................................................................................... 4117
RadiosityViewFactorType ............................................................................................................ 4117
RadiusOfReferenceSphereDefineBy ............................................................................................. 4117
RandomSamplingType ................................................................................................................ 4118
RBDCorrectionType ..................................................................................................................... 4118
RBDDoStaticAnalysisType ........................................................................................................... 4118
RBDProgramControlType ............................................................................................................ 4119
RBDTimeIntegrationType ............................................................................................................ 4119
ReactionForceCriteriaType .......................................................................................................... 4120
ReferenceFrameType .................................................................................................................. 4120
ReflectionCoefficientsType .......................................................................................................... 4121
ReinforcingStressState ................................................................................................................ 4121
RemoteApplicationType .............................................................................................................. 4121
RemotePointDOFSelectionType .................................................................................................. 4121
RemotePointUpdateOptions ....................................................................................................... 4122
ResponseConstraintDefineBy ...................................................................................................... 4122
ResponseConstraintType ............................................................................................................. 4122
RestartControlsType .................................................................................................................... 4123
RestartRetainFilesType ................................................................................................................ 4123
RestartSaveAtLoadStep ............................................................................................................... 4124
RestartSaveAtSubstep ................................................................................................................. 4124
RestartType ................................................................................................................................ 4124
ResultAnimationRangeType ........................................................................................................ 4125

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

ResultAveragingType .................................................................................................................. 4125

ResultFileCompressionType ........................................................................................................ 4125
ResultFileItemType ..................................................................................................................... 4126
ResultRelativityType .................................................................................................................... 4126
ResultType .................................................................................................................................. 4126
RigidBodyTransformationType .................................................................................................... 4134
RigidResponseEffectType ............................................................................................................ 4135
RobustFrequenciesReductionType .............................................................................................. 4135
RotationPlane ............................................................................................................................. 4135
RSBoundaryConditionSelectionType ........................................................................................... 4136
SafetyLimitType .......................................................................................................................... 4136
SafetyTheoryType ....................................................................................................................... 4136
ScaleFactorType .......................................................................................................................... 4137
ScatteredFieldFormulation .......................................................................................................... 4137
ScatteringOutputType ................................................................................................................ 4137
SecondaryImportPrefType .......................................................................................................... 4138
SectionPlaneCappingType .......................................................................................................... 4138
SectionPlaneType ....................................................................................................................... 4138
SelectionActionType ................................................................................................................... 4139
SelectionCriterionType ................................................................................................................ 4139
SelectionOperatorType ............................................................................................................... 4142
SelectionType ............................................................................................................................. 4143
SendAs ....................................................................................................................................... 4144
SeqSelectionMode ...................................................................................................................... 4144
SequenceSelectionType .............................................................................................................. 4145
SetDriverStyle ............................................................................................................................. 4145
ShearMomentDiagramOrientationType ....................................................................................... 4145
ShearMomentType ..................................................................................................................... 4146
ShearOrientationType ................................................................................................................. 4146
ShellBodyDimension ................................................................................................................... 4146
ShellElementStiffnessOption ....................................................................................................... 4147
ShellFaceType ............................................................................................................................. 4147
ShellInertiaUpdate ...................................................................................................................... 4147
ShellMBPOrientationType ........................................................................................................... 4148
ShellMBPType ............................................................................................................................. 4148
ShellOffsetType ........................................................................................................................... 4148
ShellThicknessUpdate ................................................................................................................. 4149
SizingBehavior ............................................................................................................................ 4149
SizingType .................................................................................................................................. 4149
SlidingContactType ..................................................................................................................... 4150
SnapType ................................................................................................................................... 4150
SolutionCombinationDriverStyle ................................................................................................. 4150
SolutionCombinationWorksheetType .......................................................................................... 4151
SolutionOutputType ................................................................................................................... 4151
SolutionStatusType ..................................................................................................................... 4152
SolveBehaviourType ................................................................................................................... 4153
SolverControlsIncludeNegativeLoadMultiplier ............................................................................. 4153
SolverControlsModeReuse .......................................................................................................... 4153
SolverPivotChecking ................................................................................................................... 4154
SolverType .................................................................................................................................. 4154
SolverUnitsControlType .............................................................................................................. 4155

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

SortingType ................................................................................................................................ 4155

SourceConductorType ................................................................................................................ 4155
SourceDimension ....................................................................................................................... 4155
SpacingOptionType .................................................................................................................... 4156
SpatialRadiationType .................................................................................................................. 4156
SpatialReductionMethodType ..................................................................................................... 4156
SpatialReductionType ................................................................................................................. 4157
SpectrumType ............................................................................................................................ 4157
SpinSofteningType ..................................................................................................................... 4157
SpotWeldTypes ........................................................................................................................... 4157
SpringBehavior ........................................................................................................................... 4158
SpringPreloadType ..................................................................................................................... 4158
SpringResultType ........................................................................................................................ 4158
SpringScopingType ..................................................................................................................... 4159
SpringsStiffnessType ................................................................................................................... 4159
SpringType ................................................................................................................................. 4159
StabilizationFirstSubstepOption .................................................................................................. 4160
StabilizationMethod ................................................................................................................... 4160
StabilizationType ........................................................................................................................ 4160
StageBehavior ............................................................................................................................ 4161
StiffnessBehavior ........................................................................................................................ 4161
StiffnessMethodType .................................................................................................................. 4161
STLSupportViewType .................................................................................................................. 4162
StopAtMaxCrackExtensionType ................................................................................................... 4162
StoreModalResult ....................................................................................................................... 4162
StressStrainType ......................................................................................................................... 4163
SubScopingDefineByType ........................................................................................................... 4163
SurfaceCoatingStiffnessBehavior ................................................................................................. 4164
SweepElementOptionType .......................................................................................................... 4164
SymmetryBehavior ..................................................................................................................... 4164
SymmetryBoundaryDOFOrientation ............................................................................................ 4164
SymmetryNormalType ................................................................................................................ 4165
SymmetryRegionType ................................................................................................................. 4165
TargetCorrection ......................................................................................................................... 4165
TargetOrientation ....................................................................................................................... 4166
TetIntegrationType ..................................................................................................................... 4166
ThermalPointMassBehavior ......................................................................................................... 4166
ThermalStrainType ...................................................................................................................... 4167
ThermoelasticDampingType ....................................................................................................... 4167
ThroughThicknessBendingStress ................................................................................................. 4167
TimeHistoryDisplayType ............................................................................................................. 4168
TimePointsOptions ..................................................................................................................... 4168
TimeStepDefineByType ............................................................................................................... 4168
ToleranceType ............................................................................................................................ 4169
TopoBoundType ......................................................................................................................... 4169
TopoConstraintStressType ........................................................................................................... 4169
TopoConstraintType .................................................................................................................... 4170
TopoEnvironmentType ................................................................................................................ 4170
TopologyOptimizationResultShowType ....................................................................................... 4170
TopoObjectiveFormulation ......................................................................................................... 4171
TopoOptimizationDensityFilter ................................................................................................... 4171

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

TopoOptimizationExportDesignProperties .................................................................................. 4171

TopoOptimizationExportDesignPropertiesFileFormat .................................................................. 4172
TopoOptimizationOutputLog ...................................................................................................... 4172
TopoPropertyControlType ........................................................................................................... 4172
TotalOrDirectional ...................................................................................................................... 4172
TransferAdmittanceModelType ................................................................................................... 4173
TransformationType .................................................................................................................... 4173
TransientApplicationType ........................................................................................................... 4173
TransientDampingType ............................................................................................................... 4174
TreeFilterObjectClass .................................................................................................................. 4174
TreeFilterObjectState .................................................................................................................. 4174
TreeFilterScopingType ................................................................................................................ 4175
TriangleReduction ...................................................................................................................... 4175
UnitCategoryType ....................................................................................................................... 4175
UnitSystemIDType ...................................................................................................................... 4179
UpdateContactStiffness .............................................................................................................. 4179
UseExistingModesymFile ............................................................................................................ 4180
UserUnitSystemType ................................................................................................................... 4180
VectorDisplayType ...................................................................................................................... 4180
VectorLengthType ...................................................................................................................... 4181
VectorReductionReferenceType .................................................................................................. 4181
VectorReductionType .................................................................................................................. 4181
ViewOrientationType .................................................................................................................. 4182
VirtualCellClassType .................................................................................................................... 4182
VirtualCellGroupAutomaticBehaviorType .................................................................................... 4183
VirtualCellGroupMethodType ...................................................................................................... 4183
VirtualCellGroupRepairBehaviorType ........................................................................................... 4183
VisibilityType .............................................................................................................................. 4184
WaveType ................................................................................................................................... 4184
WBUnitSystemType .................................................................................................................... 4185
WeakSpringsType ....................................................................................................................... 4185
WeightingType ........................................................................................................................... 4186
XAxisValues ................................................................................................................................ 4186
YesNoProgrammedControlled ..................................................................................................... 4187
YesNoType .................................................................................................................................. 4187
Ansys.Mechanical.DataModel.Enums.GeometryImportPreference Namespace ........................... 4189
AnalysisType ............................................................................................................................... 4189
ComparePartsOnUpdate ............................................................................................................. 4190
ComparePartsTolerance .............................................................................................................. 4190
FacetQuality ............................................................................................................................... 4190
Format ....................................................................................................................................... 4191
MixedImportResolution .............................................................................................................. 4191
Parameters ................................................................................................................................. 4191
StitchSurfacesOnImport .............................................................................................................. 4192
Ansys.Mechanical.DataModel.Enums.ExternalModel Namespace ................................................ 4193
ImportedSurfaceLoadType .......................................................................................................... 4193
Ansys.Mechanical.DataModel.Constants Namespace .................................................................... 4195
Colors ......................................................................................................................................... 4195
Ansys.ACT.Math Namespace ........................................................................................................... 4197
Matrix4D .................................................................................................................................... 4197
Matrix4D() ............................................................................................................................ 4198

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

Matrix4D(double[]) ............................................................................................................... 4198

Matrix4D(Matrix4D) .............................................................................................................. 4199
Identity ................................................................................................................................. 4199
Determinant ......................................................................................................................... 4199
Item(int, int) .......................................................................................................................... 4199
Item(int) ............................................................................................................................... 4200
Add(Matrix4D) ...................................................................................................................... 4200
CreateMirror(Vector3D, double) ............................................................................................. 4200
CreateRotate(Vector3D, double) ............................................................................................ 4200
CreateScale(double, double, double) ..................................................................................... 4201
CreateSystem(Vector3D, Vector3D, Vector3D) ......................................................................... 4201
CreateTranslate(double, double, double) ................................................................................ 4202
Invert() ................................................................................................................................. 4202
Multiply(Matrix4D) ................................................................................................................ 4202
Scale(double, double, double) ............................................................................................... 4203
Subtract(Matrix4D) ............................................................................................................... 4203
ToString() .............................................................................................................................. 4203
Transform(Vector3D) ............................................................................................................. 4203
Translate(double, double, double) .......................................................................................... 4204
Transpose() ........................................................................................................................... 4204
op_Addition(Matrix4D, Matrix4D) .......................................................................................... 4204
op_Explicit(Matrix4D) ........................................................................................................... 4205
op_Multiply(Matrix4D, Matrix4D) ........................................................................................... 4205
op_Subtraction(Matrix4D, Matrix4D) ..................................................................................... 4205
Vector3D .................................................................................................................................... 4206
Vector3D(double[]) ............................................................................................................... 4207
Vector3D(Vector3D) .............................................................................................................. 4207
Vector3D(double, double, double) ......................................................................................... 4208
I ............................................................................................................................................ 4208
IJK ........................................................................................................................................ 4208
J ........................................................................................................................................... 4208
K .......................................................................................................................................... 4209
X .......................................................................................................................................... 4209
Y .......................................................................................................................................... 4209
Z .......................................................................................................................................... 4209
Zero ..................................................................................................................................... 4209
Item(int) ............................................................................................................................... 4209
Magnitude ............................................................................................................................ 4210
MagnitudeSquared ............................................................................................................... 4210
Add(Vector3D) ...................................................................................................................... 4210
CloneNormalized() ................................................................................................................ 4210
Cross(Vector3D, Vector3D) ..................................................................................................... 4210
CrossProduct(Vector3D) ........................................................................................................ 4211
Dot(Vector3D, Vector3D) ....................................................................................................... 4211
DotProduct(Vector3D) .......................................................................................................... 4211
Equals(object) ....................................................................................................................... 4212
GetDistance(Vector3D, Vector3D) .......................................................................................... 4212
GetDistanceSquared(Vector3D, Vector3D) ............................................................................. 4212
GetHashCode() ..................................................................................................................... 4213
Normalize() ........................................................................................................................... 4213
Subtract(Vector3D) ............................................................................................................... 4213

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

ToString() .............................................................................................................................. 4213

op_Addition(Vector3D, Vector3D) .......................................................................................... 4214
op_Division(Vector3D, double) .............................................................................................. 4214
op_Equality(Vector3D, Vector3D) ........................................................................................... 4214
op_Explicit(Vector3D) ........................................................................................................... 4215
op_Inequality(Vector3D, Vector3D) ........................................................................................ 4215
op_Multiply(double, Vector3D) .............................................................................................. 4215
op_Multiply(Vector3D, double) ............................................................................................. 4216
op_Multiply(Vector3D, Vector3D) .......................................................................................... 4216
op_Subtraction(Vector3D, Vector3D) ..................................................................................... 4216
op_UnaryNegation(Vector3D) ............................................................................................... 4217
Ansys.ACT.Interfaces.Workflow Namespace .................................................................................. 4219
ITask ........................................................................................................................................... 4219
Caption ................................................................................................................................ 4220
InternalObject ...................................................................................................................... 4220
Name ................................................................................................................................... 4220
TaskGroup ............................................................................................................................ 4220
TaskId ................................................................................................................................... 4220
ITaskGroup ................................................................................................................................. 4220
Caption ................................................................................................................................ 4221
InternalObject ...................................................................................................................... 4221
Name ................................................................................................................................... 4221
TaskGroupId ......................................................................................................................... 4221
Tasks .................................................................................................................................... 4222
ITaskInput ................................................................................................................................... 4222
ITaskOutput ................................................................................................................................ 4222
IWBParameter ............................................................................................................................. 4222
Caption ................................................................................................................................ 4222
Usage ................................................................................................................................... 4223
Value .................................................................................................................................... 4223
IWBProperty ............................................................................................................................... 4223
Value .................................................................................................................................... 4223
IWorkflowDataModel .................................................................................................................. 4223
TaskGroups ........................................................................................................................... 4224
Tasks .................................................................................................................................... 4224
GetTaskByCoordinate(string) ................................................................................................. 4224
GetTaskById(string) ............................................................................................................... 4225
GetTaskGroupByDirectoryName(string) ................................................................................. 4225
GetTaskGroupById(string) ..................................................................................................... 4225
IWorkflowTask ............................................................................................................................ 4225
InternalObject ...................................................................................................................... 4226
SourceTasks .......................................................................................................................... 4226
IWorkflowTaskGroup ................................................................................................................... 4226
InternalObject ...................................................................................................................... 4226
Tasks .................................................................................................................................... 4227
ParameterUsage ......................................................................................................................... 4227
Ansys.ACT.Interfaces.Wizard Namespace ....................................................................................... 4229
IStepUserInterface ...................................................................................................................... 4229
Panel .................................................................................................................................... 4229
GetComponent(string) .......................................................................................................... 4229
IWizard ....................................................................................................................................... 4230

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

CurrentStep .......................................................................................................................... 4230

Description ........................................................................................................................... 4230
Extension ............................................................................................................................. 4230
Filename .............................................................................................................................. 4231
Folder ................................................................................................................................... 4231
Name ................................................................................................................................... 4231
Steps .................................................................................................................................... 4231
IWizardStep ................................................................................................................................ 4231
ComponentName ................................................................................................................. 4232
Context ................................................................................................................................ 4232
HelpFile ................................................................................................................................ 4232
IsEnabled .............................................................................................................................. 4232
Layout .................................................................................................................................. 4233
NextEnabledStep .................................................................................................................. 4233
NextStep .............................................................................................................................. 4233
PreviousEnabledStep ............................................................................................................ 4233
PreviousStep ......................................................................................................................... 4233
StepId ................................................................................................................................... 4233
SystemName ........................................................................................................................ 4234
UserInterface ........................................................................................................................ 4234
Wizard .................................................................................................................................. 4234
Ansys.ACT.Interfaces.UserObject Namespace ................................................................................ 4235
IPropertyCollection ..................................................................................................................... 4235
Count ................................................................................................................................... 4236
Item(string) .......................................................................................................................... 4236
Contains(ISimProperty) ......................................................................................................... 4236
GetByName(string) ............................................................................................................... 4236
ISimProperty ............................................................................................................................... 4236
Attributes ............................................................................................................................. 4237
Caption ................................................................................................................................ 4238
Control ................................................................................................................................. 4238
Controller ............................................................................................................................. 4238
DefaultValue ......................................................................................................................... 4238
Displayed ............................................................................................................................. 4238
HasUnit ................................................................................................................................ 4238
Id ......................................................................................................................................... 4239
InternalValue ........................................................................................................................ 4239
IsGroup ................................................................................................................................ 4239
IsNativeTable ........................................................................................................................ 4239
IsTable .................................................................................................................................. 4239
IsValid ................................................................................................................................... 4239
Name ................................................................................................................................... 4240
Options ................................................................................................................................ 4240
ParentCaption ...................................................................................................................... 4240
ParentPropertyGroup ............................................................................................................ 4240
QuantityName ...................................................................................................................... 4240
ReadOnly .............................................................................................................................. 4240
StateMessage ....................................................................................................................... 4241
StateMessageType ................................................................................................................ 4241
UniqueName ........................................................................................................................ 4241
UnitString ............................................................................................................................. 4241

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

Value .................................................................................................................................... 4241

ValueString ........................................................................................................................... 4241
Visible .................................................................................................................................. 4242
ISimPropertyGroup ..................................................................................................................... 4242
AllDescendants ..................................................................................................................... 4242
Display ................................................................................................................................. 4242
Properties ............................................................................................................................. 4242
ISimPropertyTable ...................................................................................................................... 4243
ActiveRow ............................................................................................................................ 4243
RowCount ............................................................................................................................ 4243
UpdateStateFreq ................................................................................................................... 4243
ValidState ............................................................................................................................. 4243
AddRow() ............................................................................................................................. 4244
DeleteRow(int) ...................................................................................................................... 4244
SaveActiveRow() ................................................................................................................... 4244
IUserLoad ................................................................................................................................... 4244
AffectsSolution ..................................................................................................................... 4245
Color .................................................................................................................................... 4245
IsLoad ................................................................................................................................... 4245
IsSupport .............................................................................................................................. 4245
Suppressed ........................................................................................................................... 4245
CreateChild(string) ................................................................................................................ 4246
IUserObject ................................................................................................................................ 4246
AllProperties ......................................................................................................................... 4246
Attributes ............................................................................................................................. 4247
Caption ................................................................................................................................ 4247
Controller ............................................................................................................................. 4247
Extension ............................................................................................................................. 4247
Icon ...................................................................................................................................... 4247
Id ......................................................................................................................................... 4247
InternalCaption ..................................................................................................................... 4248
Name ................................................................................................................................... 4248
Properties ............................................................................................................................. 4248
State ..................................................................................................................................... 4248
Version ................................................................................................................................. 4248
NotifyChange() ..................................................................................................................... 4248
IUserResult ................................................................................................................................. 4249
CalculateTimeHistory ............................................................................................................ 4249
HasImaginary ....................................................................................................................... 4249
ResultAveraging ................................................................................................................... 4249
ResultLocation ...................................................................................................................... 4250
ResultType ............................................................................................................................ 4250
Suppressed ........................................................................................................................... 4250
Unit ...................................................................................................................................... 4250
IUserSolver ................................................................................................................................. 4250
AnalysisType ......................................................................................................................... 4251
PhysicsType .......................................................................................................................... 4251
ObjectLocationEnum .................................................................................................................. 4251
ObjectTypeEnum ........................................................................................................................ 4251
PropertyDisplayEnum ................................................................................................................. 4252
UpdateStateFreqEnum ................................................................................................................ 4252

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

ValidStateEnum .......................................................................................................................... 4252

Ansys.ACT.Interfaces.UserInterface Namespace ............................................................................ 4255
ButtonClickedEventArgs ............................................................................................................. 4255
ButtonPositionType .................................................................................................................... 4256
EntryTypeEnum .......................................................................................................................... 4256
IComponentRenderer ................................................................................................................. 4256
Container ............................................................................................................................. 4256
InitDataFromJson(string) ....................................................................................................... 4257
Refresh() ............................................................................................................................... 4257
IContainer ................................................................................................................................... 4257
LastMouseX .......................................................................................................................... 4257
LastMouseY .......................................................................................................................... 4258
Name ................................................................................................................................... 4258
Renderer .............................................................................................................................. 4258
Hide() ................................................................................................................................... 4258
LocalToGlobal(int, int, out Int32, out Int32) ............................................................................. 4258
ShowPanel(IPanel) ................................................................................................................ 4259
IEntry ......................................................................................................................................... 4259
Caption ................................................................................................................................ 4260
Checked ............................................................................................................................... 4260
Enabled ................................................................................................................................ 4260
Entries .................................................................................................................................. 4260
EntryType ............................................................................................................................. 4260
Visible .................................................................................................................................. 4260
INamed ...................................................................................................................................... 4261
Name ................................................................................................................................... 4261
INamedCollection<T> ................................................................................................................. 4261
Item(string) .......................................................................................................................... 4261
Names .................................................................................................................................. 4262
IProgressMonitor ........................................................................................................................ 4262
CanAbort .............................................................................................................................. 4263
CanInterrupt ......................................................................................................................... 4263
CompletedWorkUnits ............................................................................................................ 4263
Parent ................................................................................................................................... 4263
PropagateWorkDetails .......................................................................................................... 4263
PropagateWorkStatus ........................................................................................................... 4263
Status ................................................................................................................................... 4264
TotalWorkUnits ..................................................................................................................... 4264
WorkDetails .......................................................................................................................... 4264
WorkName ........................................................................................................................... 4264
WorkStatus ........................................................................................................................... 4264
BeginWork(string, double) ..................................................................................................... 4264
CreateChildMonitor(double) ................................................................................................. 4265
EndWork() ............................................................................................................................. 4265
UpdateWork(double) ............................................................................................................ 4265
IRenderer .................................................................................................................................... 4265
CreateDialogContainer(string, int, int, int, int) ......................................................................... 4266
CreatePanelContainer(string, string, int, int) ............................................................................ 4266
CreateVirtualContainer(string) .............................................................................................. 4267
GetContainer(string) ............................................................................................................. 4267
IToolbar ...................................................................................................................................... 4267

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

Caption ................................................................................................................................ 4268

Entries .................................................................................................................................. 4268
Visible .................................................................................................................................. 4268
IUserInterface ............................................................................................................................. 4268
IsBatchMode ......................................................................................................................... 4269
ProgressMonitor ................................................................................................................... 4269
Toolbars ............................................................................................................................... 4269
UIRenderer ........................................................................................................................... 4269
GetExtensionToolbars(IExtension) ......................................................................................... 4269
LinkClickedEventArgs ................................................................................................................. 4270
ListItemCheckChangedEventArgs ............................................................................................... 4270
ListItemSelectedEventArgs .......................................................................................................... 4270
ProgressStatus ............................................................................................................................ 4270
ToggleButtonClickedEventArgs ................................................................................................... 4271
Ansys.ACT.Interfaces.UserInterface.Components Namespace ...................................................... 4273
ComponentListAlignment ........................................................................................................... 4273
IButtonComponent ..................................................................................................................... 4274
ButtonClicked ....................................................................................................................... 4274
Used ..................................................................................................................................... 4274
SetBasicDatas(string, string, string) ........................................................................................ 4274
SetCaptionFontSize(int) ........................................................................................................ 4275
SetImageSize(int, int) ............................................................................................................ 4275
SetSize(int, int) ...................................................................................................................... 4275
IButtonsComponent ................................................................................................................... 4276
ButtonClicked ....................................................................................................................... 4276
AddButton(string, string, ButtonPositionType, bool, bool) ....................................................... 4276
ClearButtons() ....................................................................................................................... 4277
SetEnabledFlag(string, bool) .................................................................................................. 4277
SetMessage(string) ............................................................................................................... 4277
IButtonWithMenuComponent ..................................................................................................... 4278
IChartComponent ....................................................................................................................... 4278
Bar(IList<object>, IList<object>, IList<string>, string) ............................................................. 4279
Bubble(IList<object>, IList<object>, IList<object>, IList<string>, IList<string>, string, string) .... 4279
Pie(IList<object>, IList<object>) ............................................................................................ 4280
Plot(IList<object>, IList<object>, string, string) ...................................................................... 4280
Reset() .................................................................................................................................. 4281
ShowLegend(bool) ............................................................................................................... 4281
Title(string) ........................................................................................................................... 4281
XLabel(string) ....................................................................................................................... 4282
XTickFormat(string) .............................................................................................................. 4282
Y2Label(string) ..................................................................................................................... 4282
Y2TickFormat(string) ............................................................................................................. 4283
YLabel(string) ....................................................................................................................... 4283
YTickFormat(string) .............................................................................................................. 4283
IDygraphComponent .................................................................................................................. 4284
RangeSelectorPlotFillColor .................................................................................................... 4284
RangeSelectorPlotStrokeColor .............................................................................................. 4284
ShowRangeSelector .............................................................................................................. 4285
Title ...................................................................................................................................... 4285
XLabel .................................................................................................................................. 4285
Y2Label ................................................................................................................................ 4285

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

YLabel .................................................................................................................................. 4285

AddSeries(IDictionary<double, double>, string, string) ........................................................... 4285
DrawPoints(bool, string) ........................................................................................................ 4286
RemoveSeries(string) ............................................................................................................ 4286
Reset() .................................................................................................................................. 4286
IEditorComponent ...................................................................................................................... 4287
IFrameComponent ...................................................................................................................... 4287
SetHtmlContent(string) ......................................................................................................... 4287
IHelpComponent ........................................................................................................................ 4287
SetHtmlContent(string) ......................................................................................................... 4288
SetHtmlContent(string, string) ............................................................................................... 4288
IHtmlComponent ........................................................................................................................ 4288
SetHtmlContent(string) ......................................................................................................... 4289
IImageComponent ...................................................................................................................... 4289
IListComponent .......................................................................................................................... 4289
Alignment ............................................................................................................................ 4290
MaxColumnCount ................................................................................................................. 4290
AddComponent(IComponentRenderer, int) ........................................................................... 4290
ClearComponents(bool) ........................................................................................................ 4290
GetComponent(string) .......................................................................................................... 4291
RemoveComponentByName(string) ...................................................................................... 4291
SetOffset(float, float) ............................................................................................................. 4291
SetWidth(float, ComponentLengthType) ............................................................................... 4292
IPopupMenuComponent ............................................................................................................ 4292
IProgressComponent .................................................................................................................. 4292
Reset() .................................................................................................................................. 4292
UpdateProgress(string, int, bool, ProgressTypeMessage) ......................................................... 4293
IPropertiesComponent ................................................................................................................ 4293
PropertyChanged ................................................................................................................. 4293
UpdateData() ........................................................................................................................ 4294
ISceneGraphComponent ............................................................................................................. 4294
ISearchBarComponent ................................................................................................................ 4294
ITabularDataComponent ............................................................................................................. 4294
ITitleComponent ......................................................................................................................... 4294
ITreeComponent ......................................................................................................................... 4295
ITreeGridComponent .................................................................................................................. 4295
IsEditable .............................................................................................................................. 4295
SetModel(ITreeGridModel) .................................................................................................... 4295
ProgressTypeMessage ................................................................................................................. 4296
Ansys.ACT.Interfaces.UserInterface.Components.ToolbarComponents Namespace .................... 4297
IToolbarComponent .................................................................................................................... 4297
Ansys.ACT.Interfaces.Reporting Namespace ................................................................................. 4299
IReport ....................................................................................................................................... 4299
ChildCount ........................................................................................................................... 4299
FilePath ................................................................................................................................ 4300
ImageDirectoryPath .............................................................................................................. 4300
AddChild(IReportItem) .......................................................................................................... 4300
AddChild(IReportItem, int) .................................................................................................... 4300
GetChild(int) ......................................................................................................................... 4301
RemoveChild(int) .................................................................................................................. 4301
IReportItem ................................................................................................................................ 4301

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

Name ................................................................................................................................... 4301

Ansys.ACT.Interfaces.Project Namespace ...................................................................................... 4303
IProjectDataModel ...................................................................................................................... 4303
CurrentUnitFromQuantityName(string) ................................................................................. 4303
Ansys.ACT.Interfaces.Post Namespace ........................................................................................... 4305
IComponentInfo ......................................................................................................................... 4305
Name ................................................................................................................................... 4306
QuantityName ...................................................................................................................... 4306
Unit ...................................................................................................................................... 4306
ICustomResultReader .................................................................................................................. 4306
GetComponentNames(string) ............................................................................................... 4307
GetComponentUnit(string, string) ......................................................................................... 4307
GetResultLocation(string) ..................................................................................................... 4307
GetResultNames() ................................................................................................................. 4307
GetResultType(string) ........................................................................................................... 4308
GetStepValues() .................................................................................................................... 4308
GetValues(string, IResultCollector) ......................................................................................... 4308
SetCurrentStep(IStepInfo) ..................................................................................................... 4308
IResult ........................................................................................................................................ 4309
Components ......................................................................................................................... 4309
ForcedToDefault ................................................................................................................... 4310
Location ............................................................................................................................... 4310
Name ................................................................................................................................... 4310
GetComponentInfo(string) .................................................................................................... 4310
GetElementValues(int) .......................................................................................................... 4310
GetElementValues(IEnumerable<int>, bool) .......................................................................... 4311
GetNodeValues(IEnumerable<int>) ....................................................................................... 4311
GetNodeValues(int) ............................................................................................................... 4311
SelectComponents(IEnumerable<string>) ............................................................................. 4312
IResultCollector .......................................................................................................................... 4312
ComponentCount ................................................................................................................. 4313
HasImaginary ....................................................................................................................... 4313
Ids ........................................................................................................................................ 4313
Indices .................................................................................................................................. 4313
Lengths ................................................................................................................................ 4313
ContainsId(int) ...................................................................................................................... 4314
SetAllIds(List<int>, List<int>) ................................................................................................ 4314
SetAllValues(double[], IList<int>) ........................................................................................... 4314
SetAllValues(IEnumerable<double>, IEnumerable<int>) ........................................................ 4315
SetImaginaryValues(int, double[]) .......................................................................................... 4315
SetImaginaryValues(int, IEnumerable<double>) .................................................................... 4315
SetValues(int, double[]) ......................................................................................................... 4316
SetValues(int, IEnumerable<double>) .................................................................................... 4316
IResultReader ............................................................................................................................. 4316
ContactElementIds ............................................................................................................... 4317
ContactNodeIds .................................................................................................................... 4317
CurrentResultSet ................................................................................................................... 4318
CurrentTimeFreq .................................................................................................................. 4318
HasImaginaryResults ............................................................................................................. 4318
Layer .................................................................................................................................... 4318
LayeredSolidStressStyle ........................................................................................................ 4318

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

ListTimeFreq ......................................................................................................................... 4318

ResultNames ......................................................................................................................... 4319
ResultSetCount ..................................................................................................................... 4319
ShellPosition ......................................................................................................................... 4319
TransformsToGlobal .............................................................................................................. 4319
CreateMeshData() ................................................................................................................. 4319
GetResult(string, MechanicalUnitSystem) ............................................................................... 4320
NumberValuesByElement(IList<int>) ..................................................................................... 4320
IStepInfo ..................................................................................................................................... 4320
DefineBy ............................................................................................................................... 4321
Set ........................................................................................................................................ 4321
Time ..................................................................................................................................... 4321
ResultAveragingEnum ................................................................................................................. 4321
ResultLocationEnum ................................................................................................................... 4322
ResultTypeEnum ......................................................................................................................... 4322
ShellPosition ............................................................................................................................... 4322
StepDefineByEnum ..................................................................................................................... 4323
StressStyle .................................................................................................................................. 4323
Ansys.ACT.Interfaces.Mesh Namespace ......................................................................................... 4325
ElementTypeEnum ...................................................................................................................... 4325
IElement ..................................................................................................................................... 4326
Area ..................................................................................................................................... 4326
Centroid ............................................................................................................................... 4327
CornerNodeCount ................................................................................................................ 4327
CornerNodeIds ..................................................................................................................... 4327
CornerNodes ........................................................................................................................ 4327
Dimension ............................................................................................................................ 4327
Id ......................................................................................................................................... 4327
NodeIds ................................................................................................................................ 4328
Nodes ................................................................................................................................... 4328
Type ..................................................................................................................................... 4328
Volume ................................................................................................................................. 4328
IMeshComputedData .................................................................................................................. 4328
ContactElementIds ............................................................................................................... 4329
ContactNodeIds .................................................................................................................... 4329
IMeshData .................................................................................................................................. 4329
ElementCount ...................................................................................................................... 4330
ElementIds ........................................................................................................................... 4330
Elements .............................................................................................................................. 4330
NodeCount ........................................................................................................................... 4330
NodeIds ................................................................................................................................ 4330
Nodes ................................................................................................................................... 4330
Unit ...................................................................................................................................... 4331
UseCache ............................................................................................................................. 4331
ElementById(int) ................................................................................................................... 4331
ElementIdsFromNodeIds(IEnumerable<int>) ......................................................................... 4331
MeshRegionById(int) ............................................................................................................. 4332
NodeById(int) ....................................................................................................................... 4332
NodeIdsFromElementIds(IEnumerable<int>) ......................................................................... 4332
IMeshRegion .............................................................................................................................. 4332
ElementCount ...................................................................................................................... 4333

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

ElementIds ........................................................................................................................... 4333

Elements .............................................................................................................................. 4333
NodeCount ........................................................................................................................... 4333
NodeIds ................................................................................................................................ 4334
Nodes ................................................................................................................................... 4334
INode ......................................................................................................................................... 4334
BodyIds ................................................................................................................................ 4334
ConnectedElementIds ........................................................................................................... 4335
ConnectedElements .............................................................................................................. 4335
GeoEntityIds ......................................................................................................................... 4335
Id ......................................................................................................................................... 4335
X .......................................................................................................................................... 4335
Y .......................................................................................................................................... 4335
Z .......................................................................................................................................... 4336
Ansys.ACT.Interfaces.Graphics Namespace .................................................................................... 4337
IBodyView .................................................................................................................................. 4337
Name ................................................................................................................................... 4338
Selection .............................................................................................................................. 4338
ICamera ...................................................................................................................................... 4338
ZoomFactor .......................................................................................................................... 4338
GetLocation() ........................................................................................................................ 4338
GetTarget() ........................................................................................................................... 4339
ICamera2 .................................................................................................................................... 4339
Location ............................................................................................................................... 4339
PerspectViewAngle ............................................................................................................... 4339
RotationalCenter ................................................................................................................... 4340
Target ................................................................................................................................... 4340
UpVector .............................................................................................................................. 4340
ZoomShift ............................................................................................................................ 4340
IDraw2DContext ......................................................................................................................... 4340
Clear() ................................................................................................................................... 4341
DrawText2D(IPoint, string) ..................................................................................................... 4341
DrawText2D(int, int, string) .................................................................................................... 4341
LineTo2D(IPoint) ................................................................................................................... 4342
LineTo2D(int, int) ................................................................................................................... 4342
MoveTo2D(IPoint) ................................................................................................................. 4342
MoveTo2D(int, int) ................................................................................................................ 4343
IDraw3DContext ......................................................................................................................... 4343
Close() .................................................................................................................................. 4344
DrawCircle(IEnumerable<double>, double, IEnumerable<double>) ....................................... 4344
DrawDisc(IEnumerable<double>, double, IEnumerable<double>) ......................................... 4344
DrawPoints(IEnumerable<double>) ...................................................................................... 4345
DrawPoints(IEnumerable<double>, double) .......................................................................... 4345
DrawPolygon(IEnumerable<double>, IEnumerable<double>) ............................................... 4345
DrawPolyline(IEnumerable<double>, bool) ........................................................................... 4346
DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ....................... 4346
DrawShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumer-
able<int>) ............................................................................................................................ 4347
SetTransformation(double[]) ................................................................................................. 4347
IDrawContext ............................................................................................................................. 4348
Color .................................................................................................................................... 4348

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

DepthTest ............................................................................................................................. 4348

LineWeight ........................................................................................................................... 4348
Translucency ......................................................................................................................... 4348
Visible .................................................................................................................................. 4349
IFactory2D .................................................................................................................................. 4349
CreatePolyline() .................................................................................................................... 4349
CreatePolyline(IEnumerable<IPoint>) .................................................................................... 4349
CreateText() .......................................................................................................................... 4350
CreateText(IPoint, string) ....................................................................................................... 4350
IFactory3D .................................................................................................................................. 4350
CreateArrow(double) ............................................................................................................ 4352
CreateArrow(double, double, double, double) ........................................................................ 4352
CreateBox(double, double, double) ........................................................................................ 4352
CreateCircle(double) ............................................................................................................. 4353
CreateCone(double, double) ................................................................................................. 4353
CreateCone(double, double, double) ..................................................................................... 4353
CreateCylinder(double, double) ............................................................................................. 4354
CreateDisc(double) ............................................................................................................... 4354
CreateGeometry(IGeoEntity) ................................................................................................. 4355
CreateMesh(IElement) ........................................................................................................... 4355
CreateMesh(IEnumerable<IElement>) ................................................................................... 4355
CreateMesh(IMeshData) ........................................................................................................ 4355
CreateMesh(IMeshRegion) .................................................................................................... 4356
CreateNodeBox(IEnumerable<INode>) ................................................................................. 4356
CreateNodeBox(INode) ......................................................................................................... 4356
CreateNodeBox(IEnumerable<INode>, double) ..................................................................... 4357
CreateNodeBox(INode, double) ............................................................................................. 4357
CreatePoint() ........................................................................................................................ 4357
CreatePoint(IEnumerable<IWorldPoint>, double) ................................................................... 4357
CreatePoint(IWorldPoint, double) .......................................................................................... 4358
CreatePolyline() .................................................................................................................... 4358
CreatePolyline(IEnumerable<IWorldPoint>) ........................................................................... 4358
CreateQuad(double, double) ................................................................................................. 4359
CreateShell() ......................................................................................................................... 4359
CreateShell(IGeoTessellation, IEnumerable<int>) ................................................................... 4359
CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ..................... 4360
CreateShell(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumer-
able<int>) ............................................................................................................................ 4360
CreateSphere(double) ........................................................................................................... 4361
CreateTriad(double) .............................................................................................................. 4361
IGraphics .................................................................................................................................... 4361
Camera ................................................................................................................................. 4362
Scene ................................................................................................................................... 4362
Unit ...................................................................................................................................... 4362
CreatePixelPoint(int, int) ........................................................................................................ 4362
CreateVector3D(double, double, double) ............................................................................... 4363
CreateWorldPoint(double, double, double) ............................................................................ 4363
ExportScreenToImage(string) ................................................................................................ 4364
ForceResume() ...................................................................................................................... 4364
Redraw() ............................................................................................................................... 4364
Suspend() ............................................................................................................................. 4364

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

IGraphicsCollection ..................................................................................................................... 4364

Entities ................................................................................................................................. 4365
Factory2D ............................................................................................................................. 4365
Factory3D ............................................................................................................................. 4365
Clear() ................................................................................................................................... 4365
CreateChildCollection() ......................................................................................................... 4366
Remove(IGraphicsCollection) ................................................................................................ 4366
Remove(IGraphicsEntity) ....................................................................................................... 4366
IPixelPoint .................................................................................................................................. 4366
X .......................................................................................................................................... 4367
Y .......................................................................................................................................... 4367
Set(int, int) ............................................................................................................................ 4367
IPoint .......................................................................................................................................... 4367
Changed ............................................................................................................................... 4368
Clone() ................................................................................................................................. 4368
ToPixelPoint() ........................................................................................................................ 4368
ToWorldPoint() ...................................................................................................................... 4368
ISuspendController ..................................................................................................................... 4368
Resume() .............................................................................................................................. 4369
ITransformable ............................................................................................................................ 4369
Transformation3D ................................................................................................................. 4369
ITransformation3D ...................................................................................................................... 4369
Item(int, int) .......................................................................................................................... 4370
Scale ..................................................................................................................................... 4370
Reset() .................................................................................................................................. 4371
Rotate(IVector3D, double) ..................................................................................................... 4371
Set(double[]) ........................................................................................................................ 4371
Set(IWorldPoint) ................................................................................................................... 4371
Set(IWorldPoint, IVector3D) ................................................................................................... 4372
Set(IWorldPoint, IVector3D, IVector3D) ................................................................................... 4372
Set(IWorldPoint, IVector3D, IVector3D, IVector3D) ................................................................... 4372
ToArray() ............................................................................................................................... 4373
Translate(IVector3D) .............................................................................................................. 4373
Translate(double, double, double) .......................................................................................... 4373
IVector3D ................................................................................................................................... 4374
X .......................................................................................................................................... 4374
Y .......................................................................................................................................... 4375
Z .......................................................................................................................................... 4375
CrossProduct(IVector3D) ....................................................................................................... 4375
GetNormal() .......................................................................................................................... 4375
IsColinearTo(IVector3D) ......................................................................................................... 4375
IsColinearTo(IVector3D, double) ............................................................................................. 4376
Length() ............................................................................................................................... 4376
Normalize() ........................................................................................................................... 4376
SquareLength() ..................................................................................................................... 4376
IWorldPoint ................................................................................................................................ 4377
X .......................................................................................................................................... 4377
Y .......................................................................................................................................... 4377
Z .......................................................................................................................................... 4377
Ansys.ACT.Interfaces.Graphics.Entities Namespace ...................................................................... 4379
IArrow3D .................................................................................................................................... 4379

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

Body ..................................................................................................................................... 4380

BodyLength .......................................................................................................................... 4380
BodyRadius .......................................................................................................................... 4380
Head .................................................................................................................................... 4380
HeadLength .......................................................................................................................... 4380
HeadRadius .......................................................................................................................... 4381
Length .................................................................................................................................. 4381
IBox3D ........................................................................................................................................ 4381
X .......................................................................................................................................... 4381
Y .......................................................................................................................................... 4381
Z .......................................................................................................................................... 4382
ICircle3D ..................................................................................................................................... 4382
Radius .................................................................................................................................. 4382
ICone3D ..................................................................................................................................... 4382
BottomRadius ....................................................................................................................... 4383
Closed .................................................................................................................................. 4383
Length .................................................................................................................................. 4383
Samples ................................................................................................................................ 4383
TopRadius ............................................................................................................................. 4383
IDisc3D ....................................................................................................................................... 4383
Radius .................................................................................................................................. 4384
IGeometry3D .............................................................................................................................. 4384
DisplayEdge .......................................................................................................................... 4384
DisplayFace .......................................................................................................................... 4385
DisplayVertex ........................................................................................................................ 4385
EdgeColor ............................................................................................................................. 4385
FaceColor ............................................................................................................................. 4385
VertexColor ........................................................................................................................... 4385
VertexSize ............................................................................................................................. 4385
IGraphicsEntity ........................................................................................................................... 4386
Color .................................................................................................................................... 4386
DepthTest ............................................................................................................................. 4386
Is2D ...................................................................................................................................... 4386
Is3D ...................................................................................................................................... 4387
LineWeight ........................................................................................................................... 4387
Name ................................................................................................................................... 4387
Translucency ......................................................................................................................... 4387
Visible .................................................................................................................................. 4387
Delete() ................................................................................................................................ 4387
IMesh3D ..................................................................................................................................... 4388
INodeBox3D ............................................................................................................................... 4388
Size ...................................................................................................................................... 4388
IPoint3D ..................................................................................................................................... 4388
Points ................................................................................................................................... 4389
Size ...................................................................................................................................... 4389
IPolyline<T> ............................................................................................................................... 4389
Closed .................................................................................................................................. 4389
EndPoint ............................................................................................................................... 4389
Length .................................................................................................................................. 4390
Points ................................................................................................................................... 4390
StartPoint ............................................................................................................................. 4390

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

IQuad3D ..................................................................................................................................... 4390

X .......................................................................................................................................... 4390
Y .......................................................................................................................................... 4391
IShell3D ...................................................................................................................................... 4391
Colors ................................................................................................................................... 4391
Connectivity ......................................................................................................................... 4392
HasColors ............................................................................................................................. 4392
Initialized .............................................................................................................................. 4392
Normals ................................................................................................................................ 4392
TriangleCount ....................................................................................................................... 4392
Vertices ................................................................................................................................ 4392
SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>) ................... 4393
SetAttributes(IEnumerable<double>, IEnumerable<double>, IEnumerable<int>, IEnumer-
able<int>) ............................................................................................................................ 4393
ISphere3D .................................................................................................................................. 4394
Radius .................................................................................................................................. 4394
Samples ................................................................................................................................ 4394
IText2D ....................................................................................................................................... 4394
Origin ................................................................................................................................... 4395
Text ...................................................................................................................................... 4395
ITriad3D ...................................................................................................................................... 4395
Length .................................................................................................................................. 4395
XArrow ................................................................................................................................. 4395
YArrow ................................................................................................................................. 4396
ZArrow ................................................................................................................................. 4396
Ansys.ACT.Interfaces.Geometry Namespace .................................................................................. 4397
GeoBodyTypeEnum .................................................................................................................... 4397
GeoCellTypeEnum ...................................................................................................................... 4398
GeoCurveTypeEnum ................................................................................................................... 4398
GeoSurfaceTypeEnum ................................................................................................................ 4399
IBaseGeoBody ............................................................................................................................ 4399
Area ..................................................................................................................................... 4400
BodyType ............................................................................................................................. 4400
Centroid ............................................................................................................................... 4400
Edges ................................................................................................................................... 4400
Faces .................................................................................................................................... 4401
Length .................................................................................................................................. 4401
Vertices ................................................................................................................................ 4401
Volume ................................................................................................................................. 4401
IBaseGeoBodyOrPart ................................................................................................................... 4401
IBaseGeoEdge ............................................................................................................................. 4401
Bodies .................................................................................................................................. 4402
Centroid ............................................................................................................................... 4402
CurveType ............................................................................................................................ 4402
EndVertex ............................................................................................................................. 4402
Faces .................................................................................................................................... 4403
Length .................................................................................................................................. 4403
StartVertex ........................................................................................................................... 4403
Vertices ................................................................................................................................ 4403
IBaseGeoEntity ........................................................................................................................... 4403
Id ......................................................................................................................................... 4404

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

Type ..................................................................................................................................... 4404

GetBoundingBox() ................................................................................................................ 4404
IBaseGeoFace ............................................................................................................................. 4404
Area ..................................................................................................................................... 4405
Bodies .................................................................................................................................. 4405
Centroid ............................................................................................................................... 4405
Edges ................................................................................................................................... 4405
SurfaceType .......................................................................................................................... 4405
Vertices ................................................................................................................................ 4406
NormalAtParam(double, double) ........................................................................................... 4406
NormalsAtParams(double[]) .................................................................................................. 4406
ParamAtPoint(double[]) ........................................................................................................ 4406
PointAtParam(double, double) .............................................................................................. 4407
PointsAtParams(double[]) ..................................................................................................... 4407
IBaseGeoPart .............................................................................................................................. 4407
Bodies .................................................................................................................................. 4408
Name ................................................................................................................................... 4408
IBaseGeoVertex .......................................................................................................................... 4408
Bodies .................................................................................................................................. 4409
Edges ................................................................................................................................... 4409
Faces .................................................................................................................................... 4409
X .......................................................................................................................................... 4409
Y .......................................................................................................................................... 4409
Z .......................................................................................................................................... 4409
IGeoAssembly ............................................................................................................................. 4410
AllParts ................................................................................................................................. 4410
Dimension ............................................................................................................................ 4410
Name ................................................................................................................................... 4410
Parts ..................................................................................................................................... 4410
Unit ...................................................................................................................................... 4411
IGeoBody ................................................................................................................................... 4411
CrossSection ......................................................................................................................... 4411
CrossSectionOffset ................................................................................................................ 4411
CrossSectionOffsetType ........................................................................................................ 4412
Material ................................................................................................................................ 4412
Name ................................................................................................................................... 4412
Shells .................................................................................................................................... 4412
Suppressed ........................................................................................................................... 4412
Thickness .............................................................................................................................. 4412
IGeoData .................................................................................................................................... 4413
Assemblies ........................................................................................................................... 4413
GeoEntityById(int) ................................................................................................................ 4413
IGeoEdge .................................................................................................................................... 4413
CrossSectionOrientation ....................................................................................................... 4414
Extents ................................................................................................................................. 4414
IsParamReversed ................................................................................................................... 4414
ParamAtPoint(double[]) ........................................................................................................ 4414
PointAtParam(double) .......................................................................................................... 4415
PointsAtParams(double[]) ..................................................................................................... 4415
TangentAtParam(double) ...................................................................................................... 4415
TangentsAtParams(double[]) ................................................................................................. 4416

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

IGeoEntity .................................................................................................................................. 4416

GeoData ............................................................................................................................... 4416
Part ...................................................................................................................................... 4416
IGeoFace .................................................................................................................................... 4417
Loops ................................................................................................................................... 4417
Shell ..................................................................................................................................... 4417
IGeoLoop ................................................................................................................................... 4417
Edges ................................................................................................................................... 4418
Face ...................................................................................................................................... 4418
IGeoPart ..................................................................................................................................... 4418
IGeoShell .................................................................................................................................... 4418
Faces .................................................................................................................................... 4418
IGeoTessellation .......................................................................................................................... 4419
FacetCount ........................................................................................................................... 4419
Indices .................................................................................................................................. 4419
Normals ................................................................................................................................ 4419
Points ................................................................................................................................... 4419
IGeoVertex .................................................................................................................................. 4420
MaterialTypeEnum ...................................................................................................................... 4420
Ansys.ACT.Interfaces.DataModel Namespace ................................................................................ 4421
IDataModelObject ...................................................................................................................... 4421
ObjectLocation ..................................................................................................................... 4421
ObjectType ........................................................................................................................... 4421
Parent ................................................................................................................................... 4422
SupportedLocations ............................................................................................................. 4422
Ansys.ACT.Interfaces.Common Namespace ................................................................................... 4423
AngleUnitType ............................................................................................................................ 4423
AngularVelocityUnitType ............................................................................................................ 4424
IAttributeCollection .................................................................................................................... 4424
Item(string) .......................................................................................................................... 4425
Keys ..................................................................................................................................... 4425
Contains(string) .................................................................................................................... 4425
GetStringValue(string) ........................................................................................................... 4425
GetValue(string) .................................................................................................................... 4425
GetValue(string, object) ......................................................................................................... 4426
Remove(string) ..................................................................................................................... 4426
SetValue(string, object) ......................................................................................................... 4426
IBreakpoint ................................................................................................................................. 4427
IsEnabled .............................................................................................................................. 4427
Line ...................................................................................................................................... 4427
SourceFile ............................................................................................................................. 4427
IExtension ................................................................................................................................... 4428
Attributes ............................................................................................................................. 4428
InstallDir ............................................................................................................................... 4428
MinorVersion ........................................................................................................................ 4428
Name ................................................................................................................................... 4428
UniqueId .............................................................................................................................. 4429
Version ................................................................................................................................. 4429
IExtensionManager ..................................................................................................................... 4429
CurrentExtension .................................................................................................................. 4429
Extensions ............................................................................................................................ 4429

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

ILog ............................................................................................................................................ 4430

WriteError(string) .................................................................................................................. 4430
WriteMessage(string) ............................................................................................................ 4430
WriteWarning(string) ............................................................................................................ 4431
IParameter .................................................................................................................................. 4431
Key ....................................................................................................................................... 4431
Name ................................................................................................................................... 4431
Value .................................................................................................................................... 4432
IParameterManager .................................................................................................................... 4432
IProcessUtilities ........................................................................................................................... 4432
Start(string, params string[]) .................................................................................................. 4432
Start(string, bool, params string[]) .......................................................................................... 4433
ISelectionInfo ............................................................................................................................. 4433
Id ......................................................................................................................................... 4433
Ids ........................................................................................................................................ 4434
Name ................................................................................................................................... 4434
SelectionType ....................................................................................................................... 4434
ISelectionManager ...................................................................................................................... 4434
CurrentSelection ................................................................................................................... 4434
AddSelection(ISelectionInfo) ................................................................................................. 4435
ClearSelection() .................................................................................................................... 4435
CreateSelectionInfo(SelectionTypeEnum) .............................................................................. 4435
NewSelection(ISelectionInfo) ................................................................................................ 4435
ISourceFile .................................................................................................................................. 4436
Content ................................................................................................................................ 4436
FilePath ................................................................................................................................ 4436
Save() ................................................................................................................................... 4436
ITools .......................................................................................................................................... 4437
GetGeoDataFromFile(string) ................................................................................................. 4437
GetMeshDataFromFile(string, string) ..................................................................................... 4437
GetResultsDataFromFile(string) ............................................................................................. 4438
IWorksheet ................................................................................................................................. 4438
RowCount ............................................................................................................................ 4438
AddRow() ............................................................................................................................. 4438
DeleteRow(int) ...................................................................................................................... 4438
MechanicalUnitSystemEnum ....................................................................................................... 4439
MetricTemperatureUnitType ....................................................................................................... 4439
SelectionTypeEnum .................................................................................................................... 4440
State ........................................................................................................................................... 4440
StateMessageTypes .................................................................................................................... 4441
UserErrorMessageException ........................................................................................................ 4441
Ansys.ACT.Interfaces.Analysis Namespace ..................................................................................... 4443
CoordinateSystemTypeEnum ...................................................................................................... 4443
IAnalysis ..................................................................................................................................... 4443
AnalysisType ......................................................................................................................... 4445
CoordinateSystems ............................................................................................................... 4445
GeoData ............................................................................................................................... 4445
Id ......................................................................................................................................... 4446
MeshData ............................................................................................................................. 4446
Name ................................................................................................................................... 4446
PhysicsType .......................................................................................................................... 4446

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

PropertyNames ..................................................................................................................... 4446

Solver ................................................................................................................................... 4446
SolverName .......................................................................................................................... 4447
StepsEndTime ....................................................................................................................... 4447
WorkingDir ........................................................................................................................... 4447
CoordinateSystemById(int) .................................................................................................... 4447
CreateLoadObject(string, IExtension) ..................................................................................... 4447
CreateLoadObject(string, string) ............................................................................................ 4448
CreatePostObject(string, IExtension) ...................................................................................... 4448
CreatePostObject(string, string) ............................................................................................. 4449
CreateResultObject(string, IExtension) ................................................................................... 4449
CreateResultObject(string, string) .......................................................................................... 4449
CurrentConsistentUnitFromQuantityName(string) ................................................................. 4450
GenerateMesh() .................................................................................................................... 4450
GetLoadObjects(IExtension) .................................................................................................. 4450
GetLoadObjects(string) ......................................................................................................... 4450
GetResultObjects(IExtension) ................................................................................................ 4451
GetResultObjects(string) ....................................................................................................... 4451
GetResultsData() ................................................................................................................... 4451
GetUserObjects(IExtension) .................................................................................................. 4452
GetUserObjects(string) .......................................................................................................... 4452
PropertyValue(string) ............................................................................................................ 4452
PropertyValue(string, object) ................................................................................................. 4452
Solve(bool) ........................................................................................................................... 4453
Solve(bool, string) ................................................................................................................. 4453
WriteInputFile(string) ............................................................................................................ 4453
ICoordinateSystem ..................................................................................................................... 4454
CoordinateSystemType ......................................................................................................... 4454
Id ......................................................................................................................................... 4454
Matrix ................................................................................................................................... 4455
Name ................................................................................................................................... 4455
Origin ................................................................................................................................... 4455
XAxis .................................................................................................................................... 4455
YAxis ..................................................................................................................................... 4455
ZAxis .................................................................................................................................... 4455
IDataObject ................................................................................................................................ 4456
Id ......................................................................................................................................... 4456
Name ................................................................................................................................... 4456
PropertyNames ..................................................................................................................... 4456
Type ..................................................................................................................................... 4456
PropertyValue(string) ............................................................................................................ 4457
PropertyValue(string, object) ................................................................................................. 4457
IDataObjectCollection ................................................................................................................. 4457
Ids ........................................................................................................................................ 4458
List ....................................................................................................................................... 4458
Names .................................................................................................................................. 4458
GetById(int) .......................................................................................................................... 4458
GetByName(string) ............................................................................................................... 4458
GetEnumerator() ................................................................................................................... 4459
NamesByType(string) ............................................................................................................ 4459
IDataObjectContainer ................................................................................................................. 4459

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

DataObjects .......................................................................................................................... 4459

ISolverData ................................................................................................................................. 4460
CurrentStep .......................................................................................................................... 4460
MaxElementId ...................................................................................................................... 4461
MaxElementType .................................................................................................................. 4461
MaxNodeId ........................................................................................................................... 4461
SolveType ............................................................................................................................. 4461
GetContactId(int) .................................................................................................................. 4461
GetContactTargetId(int) ........................................................................................................ 4462
GetCoordinateSystemSolverId(int) ........................................................................................ 4462
GetMaterialSolverId(int) ........................................................................................................ 4462
GetNewElementId() .............................................................................................................. 4462
GetNewElementType() .......................................................................................................... 4463
GetNewNodeId() ................................................................................................................... 4463
GetRemotePointNodeId(int) .................................................................................................. 4463
SolveTypeEnum .......................................................................................................................... 4463
Ansys.DesignXplorer.API Namespace ............................................................................................ 4467
ParameterNature ........................................................................................................................ 4467
Ansys.DesignXplorer.API.Optimization Namespace ...................................................................... 4469
DXConvergenceData ................................................................................................................... 4470
DXConvergenceDescription ........................................................................................................ 4470
DXOptimizationPoint .................................................................................................................. 4470
enumAllowedContinuousValues ................................................................................................. 4470
enumConstraintHandlingType .................................................................................................... 4470
enumConstraintType .................................................................................................................. 4470
enumCurveType ......................................................................................................................... 4471
enumGoalType ........................................................................................................................... 4471
enumPostProcessingType ........................................................................................................... 4471
IConvergenceData ...................................................................................................................... 4471
get_Value(int, out Int32, out Double, out Boolean) ................................................................. 4471
put_Value(int, int, double, bool) ............................................................................................. 4472
IConvergenceDescription ............................................................................................................ 4472
IndexOfCurvesSupportingFeasibility ..................................................................................... 4473
NumberOfFeasibleCurves ..................................................................................................... 4473
NumberOfGroups ................................................................................................................. 4474
Quantity ............................................................................................................................... 4474
Unit ...................................................................................................................................... 4474
XAxisLabel ............................................................................................................................ 4474
YAxisLabel ............................................................................................................................ 4474
AddCurve(int, string, enumCurveType, bool) .......................................................................... 4474
AddGroup(string) .................................................................................................................. 4475
get_CurveLabel(int) .............................................................................................................. 4475
get_CurveType(int) ............................................................................................................... 4476
get_GroupLabel(int) ............................................................................................................. 4476
get_NumberOfCurves(int) ..................................................................................................... 4476
IGridSupport ............................................................................................................................... 4476
AddGridInterval(string, double) ............................................................................................. 4477
IOptimizationMethod ................................................................................................................. 4477
Candidates ........................................................................................................................... 4478
PostProcessingTypes ............................................................................................................. 4478
Samples ................................................................................................................................ 4478

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

Services ................................................................................................................................ 4479

AddConstraint(string, enumConstraintType, object, object, double, bool) ................................ 4479
AddCustomConstraintProperty(string, string, object) ............................................................. 4479
AddCustomObjectiveProperty(string, string, object) .............................................................. 4480
AddCustomVariableProperty(string, string, object) ................................................................. 4480
AddDoubleListVariable(string, IListCpp, double) ..................................................................... 4481
AddDoubleVariable(string, double, double, double) ............................................................... 4481
AddIntegerListVariable(string, IListCpp, int) ............................................................................ 4482
AddObjective(string, enumGoalType, double, double) ............................................................ 4482
AddOutput(string) ................................................................................................................ 4483
AddParameterRelationship(string, string, string, enumParameterRelationshipType) ................ 4483
CanRun(out String) ............................................................................................................... 4484
get_Setting(string) ................................................................................................................ 4484
put_Setting(string, object) .................................................................................................... 4484
Run() .................................................................................................................................... 4484
IOptimizationPoint ...................................................................................................................... 4485
Feasible ................................................................................................................................ 4485
ID ......................................................................................................................................... 4485
ParetoFrontIndex .................................................................................................................. 4486
State ..................................................................................................................................... 4486
StateMessage ....................................................................................................................... 4486
get_Value(string) .................................................................................................................. 4486
put_Value(string, object) ....................................................................................................... 4486
IOptimizationServices ................................................................................................................. 4487
ExistingPoints ....................................................................................................................... 4487
Stopped ............................................................................................................................... 4488
CalculateParameterRelationshipsFromPoint(IPoint) ............................................................... 4488
CalculateParameterRelationshipsFromPoints(IListCpp) .......................................................... 4488
CalculatePoint(IPoint) ............................................................................................................ 4488
CalculatePoints(IListCpp) ...................................................................................................... 4489
PublishLogMessage(string) ................................................................................................... 4489
PublishProgress(string, int) .................................................................................................... 4489
PushConvergenceData(IConvergenceData) ........................................................................... 4490
PushHistoryPoint(IOptimizationPoint) ................................................................................... 4490
PushHistoryPoints(IListCpp) .................................................................................................. 4490
IUserOptimizer ............................................................................................................................ 4490
BasedOnDirectOptimizationOnly .......................................................................................... 4493
BasedOnResponseSurfaceOnly ............................................................................................. 4493
ConstraintHandling ............................................................................................................... 4493
ConstraintImportance ........................................................................................................... 4493
ConstraintOnInputParameter ................................................................................................ 4493
ConvergenceData ................................................................................................................. 4494
EqualToConstraint ................................................................................................................ 4494
EqualToConstraintDefined .................................................................................................... 4494
GreaterThanConstraint .......................................................................................................... 4494
GreaterThanConstraintDefined ............................................................................................. 4494
HistoryChartXAxisType ......................................................................................................... 4494
InsideBoundsConstraint ........................................................................................................ 4495
InsideBoundsConstraintDefined ............................................................................................ 4495
IsDirectOptimization ............................................................................................................. 4495
LessThanConstraint ............................................................................................................... 4495

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

LessThanConstraintDefined .................................................................................................. 4495

LogFile ................................................................................................................................. 4495
MaximizeObjective ............................................................................................................... 4496
MaximizeObjectiveDefined ................................................................................................... 4496
MaximumNumberOfConstraints ........................................................................................... 4496
MaximumNumberOfDoubleListParameters ........................................................................... 4496
MaximumNumberOfDoubleParameters ................................................................................ 4496
MaximumNumberOfInputParameters ................................................................................... 4496
MaximumNumberOfIntegerListParameters ........................................................................... 4497
MaximumNumberOfObjectives ............................................................................................. 4497
MinimizeObjective ................................................................................................................ 4497
MinimizeObjectiveDefined .................................................................................................... 4497
MinimumNumberOfConstraints ............................................................................................ 4497
MinimumNumberOfObjectives ............................................................................................. 4497
NumberOfConstraintsDefined ............................................................................................... 4498
NumberOfConstraintsDefinedOnInputs ................................................................................ 4498
NumberOfDoubleListParametersDefined .............................................................................. 4498
NumberOfDoubleParametersDefined .................................................................................... 4498
NumberOfInputParametersDefined ....................................................................................... 4498
NumberOfIntegerListParametersDefined ............................................................................... 4498
NumberOfObjectivesDefined ................................................................................................ 4499
NumberOfObjectivesDefinedOnInputs .................................................................................. 4499
ObjectiveImportance ............................................................................................................ 4499
ObjectiveOnInputParameter ................................................................................................. 4499
ParameterRelationship .......................................................................................................... 4499
SeekObjective ....................................................................................................................... 4499
SeekObjectiveDefined .......................................................................................................... 4500
StartingPointRequired .......................................................................................................... 4500
Ansys.DesignXplorer.API.Sampling Namespace ............................................................................ 4501
IUserSampling ............................................................................................................................ 4501
LogFile ................................................................................................................................. 4502
MaximumNumberOfDoubleListParameters ........................................................................... 4502
MaximumNumberOfDoubleParameters ................................................................................ 4502
MaximumNumberOfInputParameters ................................................................................... 4502
MaximumNumberOfIntegerListParameters ........................................................................... 4502
NumberOfDoubleListParametersDefined .............................................................................. 4502
NumberOfDoubleParametersDefined .................................................................................... 4503
NumberOfInputParametersDefined ....................................................................................... 4503
NumberOfIntegerListParametersDefined ............................................................................... 4503
Ansys.DesignXplorer.API.Common Namespace ............................................................................. 4505
enumDistributionType ................................................................................................................ 4505
enumParameterRelationshipType ............................................................................................... 4505
enumPointState .......................................................................................................................... 4506
enumSimulationType .................................................................................................................. 4506
IMethod ..................................................................................................................................... 4506
AddDoubleListVariable(string, IListCpp, double) ..................................................................... 4507
AddDoubleVariable(string, double, double, double) ............................................................... 4507
AddIntegerListVariable(string, IListCpp, int) ............................................................................ 4508
AddOutput(string) ................................................................................................................ 4508
AddParameterRelationship(string, string, string, enumParameterRelationshipType) ................ 4508
CanRun(out String) ............................................................................................................... 4509

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

get_Setting(string) ................................................................................................................ 4509

put_Setting(string, object) .................................................................................................... 4509
Run() .................................................................................................................................... 4510
IPoint .......................................................................................................................................... 4510
ID ......................................................................................................................................... 4510
State ..................................................................................................................................... 4511
StateMessage ....................................................................................................................... 4511
get_Value(string) .................................................................................................................. 4511
put_Value(string, object) ....................................................................................................... 4511
IServices ..................................................................................................................................... 4512
ExistingPoints ....................................................................................................................... 4512
Stopped ............................................................................................................................... 4512
CalculateParameterRelationshipsFromPoint(IPoint) ............................................................... 4513
CalculateParameterRelationshipsFromPoints(IListCpp) .......................................................... 4513
CalculatePoint(IPoint) ............................................................................................................ 4513
CalculatePoints(IListCpp) ...................................................................................................... 4513
PublishLogMessage(string) ................................................................................................... 4514
PublishProgress(string, int) .................................................................................................... 4514
IUserExtensionOptimizationCriterion .......................................................................................... 4514
IUserExtensionParameter ............................................................................................................ 4515
Ansys.DesignXplorer.Automation Namespace .............................................................................. 4517
CustomConstraintProperties ....................................................................................................... 4517
DisplayText ........................................................................................................................... 4517
CustomObjectiveProperties ........................................................................................................ 4518
DisplayText ........................................................................................................................... 4518
CustomParameterProperties ....................................................................................................... 4518
DisplayText ........................................................................................................................... 4518
DiscreteLevel .............................................................................................................................. 4519
DisplayText ........................................................................................................................... 4519
Index .................................................................................................................................... 4519
Value .................................................................................................................................... 4519
HistoryChart ............................................................................................................................... 4519
DisplayParameterFullName ................................................................................................... 4520
DisplayText ........................................................................................................................... 4520
IsUpToDate ........................................................................................................................... 4520
InputParameter ........................................................................................................................... 4520
Attribute1 ............................................................................................................................. 4522
Attribute2 ............................................................................................................................. 4522
ConstantValue ...................................................................................................................... 4522
CustomDefinitionList ............................................................................................................ 4522
DiscreteLevels ....................................................................................................................... 4522
DisplayText ........................................................................................................................... 4523
DistributionLowerBound ....................................................................................................... 4523
DistributionType ................................................................................................................... 4523
DistributionUpperBound ...................................................................................................... 4523
Enabled ................................................................................................................................ 4523
Kurtosis ................................................................................................................................ 4523
LowerBound ......................................................................................................................... 4524
Mean .................................................................................................................................... 4524
Nature .................................................................................................................................. 4524
NumberOfLevels ................................................................................................................... 4524

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

Skewness .............................................................................................................................. 4524

StandardDeviation ................................................................................................................ 4524
Type ..................................................................................................................................... 4525
Units .................................................................................................................................... 4525
UpperBound ......................................................................................................................... 4525
UseManufacturableValues ..................................................................................................... 4525
OptimizationCriterion ................................................................................................................. 4525
AllowedValues ...................................................................................................................... 4526
ConstraintFirstValue .............................................................................................................. 4526
ConstraintHandling ............................................................................................................... 4527
ConstraintImportance ........................................................................................................... 4527
ConstraintSecondValue ......................................................................................................... 4527
ConstraintType ..................................................................................................................... 4527
CustomConstraintDefinitionList ............................................................................................ 4527
CustomObjectiveDefinitionList ............................................................................................. 4527
DisplayText ........................................................................................................................... 4528
GridInterval .......................................................................................................................... 4528
HistoryChart ......................................................................................................................... 4528
LowerBound ......................................................................................................................... 4528
ObjectiveImportance ............................................................................................................ 4528
ObjectiveTargetValue ............................................................................................................ 4528
ObjectiveType ...................................................................................................................... 4529
StartingValue ........................................................................................................................ 4529
Units .................................................................................................................................... 4529
UpperBound ......................................................................................................................... 4529
Ansys.ACT.WorkBench.Schematic Namespace ............................................................................... 4531
UserTask ..................................................................................................................................... 4531
ActiveDirectory ..................................................................................................................... 4532
Component .......................................................................................................................... 4532
EditIcon ................................................................................................................................ 4532
InputData ............................................................................................................................. 4533
InternalObject ...................................................................................................................... 4533
OutputData .......................................................................................................................... 4533
Parameters ........................................................................................................................... 4533
Properties ............................................................................................................................. 4533
RegisteredFiles ..................................................................................................................... 4534
SourceTasks .......................................................................................................................... 4534
TargetTasks ........................................................................................................................... 4534
TaskGroup ............................................................................................................................ 4534
TaskState .............................................................................................................................. 4534
Template .............................................................................................................................. 4534
TransferData ......................................................................................................................... 4535
Type ..................................................................................................................................... 4535
Edit( params object[]) ............................................................................................................ 4535
ExecuteCommand(string, IDictionary<string, object>) ........................................................... 4535
Exit( params object[]) ............................................................................................................ 4536
RegisterFile(string) ................................................................................................................ 4536
Send( params object[]) .......................................................................................................... 4536
SignalModified() ................................................................................................................... 4536
SignalOutputsGenerated() .................................................................................................... 4537
UnregisterFile(DataReference) ............................................................................................... 4537

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

UnregisterFile(string) ............................................................................................................ 4537

UnregisterFile(DataReference, bool) ....................................................................................... 4537
UnregisterFile(string, bool) .................................................................................................... 4538
UserTaskGroup ........................................................................................................................... 4538
Abbreviation ......................................................................................................................... 4539
Caption ................................................................................................................................ 4539
Category .............................................................................................................................. 4539
HeaderText ........................................................................................................................... 4539
InternalObject ...................................................................................................................... 4539
IsParametricGroup ................................................................................................................ 4539
Name ................................................................................................................................... 4540
Tasks .................................................................................................................................... 4540
Template .............................................................................................................................. 4540
UserTaskGroupTemplate ............................................................................................................. 4540
Abbreviation ......................................................................................................................... 4541
Caption ................................................................................................................................ 4541
Category .............................................................................................................................. 4541
HeaderText ........................................................................................................................... 4541
InternalObject ...................................................................................................................... 4541
IsParametricGroup ................................................................................................................ 4541
Name ................................................................................................................................... 4542
UserTaskTemplate ....................................................................................................................... 4542
InternalObject ...................................................................................................................... 4542
Ansys.ACT.WorkBench.Commands Namespace ............................................................................. 4543
ExecuteWorkbenchScriptCommand ............................................................................................ 4543
InvokeAndWait() ................................................................................................................... 4545
InvokeAndWait(InvokeConfiguration) .................................................................................... 4545
InvokeAndWait(IProtectedContext) ....................................................................................... 4545
InvokeAndWait(IProtectedContext, InvokeConfiguration) ....................................................... 4546
InvokeAndWait(IProtectedContext, IProgressMonitor) ............................................................ 4546
InvokeAsync() ....................................................................................................................... 4547
InvokeAsync(InvokeConfiguration) ........................................................................................ 4547
InvokeAsync(IProtectedContext) ........................................................................................... 4547
InvokeAsync(IProtectedContext, InvokeConfiguration) ........................................................... 4548
InvokeAsync(IProtectedContext, IProgressMonitor) ................................................................ 4548
Ansys.ACT.WorkBench.Automation.Workflows Namespace .......................................................... 4549
Parameter ................................................................................................................................... 4549
Caption ................................................................................................................................ 4549
InternalObject ...................................................................................................................... 4550
Name ................................................................................................................................... 4550
Usage ................................................................................................................................... 4550
Value .................................................................................................................................... 4550
Property ..................................................................................................................................... 4550
Name ................................................................................................................................... 4551
Value .................................................................................................................................... 4551
Task ............................................................................................................................................ 4551
ActiveDirectory ..................................................................................................................... 4553
AlwaysIncludeInDPUpdate .................................................................................................... 4553
Caption ................................................................................................................................ 4553
Container ............................................................................................................................. 4553
CoordinateId ........................................................................................................................ 4553

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

CoupledClients ..................................................................................................................... 4554

CoupledToTask ..................................................................................................................... 4554
DirectoryName ..................................................................................................................... 4554
ImageName .......................................................................................................................... 4554
InputData ............................................................................................................................. 4554
InternalObject ...................................................................................................................... 4554
IsFailedState ......................................................................................................................... 4555
IsSharing .............................................................................................................................. 4555
MasterTask ........................................................................................................................... 4555
Name ................................................................................................................................... 4555
Notes .................................................................................................................................... 4555
OutputData .......................................................................................................................... 4555
Parameters ........................................................................................................................... 4556
Properties ............................................................................................................................. 4556
RealTask ............................................................................................................................... 4556
Solver ................................................................................................................................... 4556
SourceTasks .......................................................................................................................... 4556
State ..................................................................................................................................... 4556
TargetTasks ........................................................................................................................... 4557
TaskGroup ............................................................................................................................ 4557
TaskId ................................................................................................................................... 4557
Template .............................................................................................................................. 4557
UsedLicenses ........................................................................................................................ 4557
UserId ................................................................................................................................... 4557
UserTask ............................................................................................................................... 4558
Clean() .................................................................................................................................. 4558
ExecuteCommand(string, IDictionary<string, object>) ........................................................... 4558
GetPropertyNames() ............................................................................................................. 4558
Refresh() ............................................................................................................................... 4559
Remove() .............................................................................................................................. 4559
Reset() .................................................................................................................................. 4559
Update() ............................................................................................................................... 4559
TaskGroup .................................................................................................................................. 4559
Abbreviation ......................................................................................................................... 4560
AnalysisType ......................................................................................................................... 4560
Caption ................................................................................................................................ 4561
DirectoryName ..................................................................................................................... 4561
HeaderText ........................................................................................................................... 4561
InternalObject ...................................................................................................................... 4561
IsParametric .......................................................................................................................... 4561
Name ................................................................................................................................... 4561
Notes .................................................................................................................................... 4562
Physics ................................................................................................................................. 4562
Solver ................................................................................................................................... 4562
TaskGroupId ......................................................................................................................... 4562
Tasks .................................................................................................................................... 4562
Template .............................................................................................................................. 4562
Clean() .................................................................................................................................. 4563
Copy() .................................................................................................................................. 4563
Delete() ................................................................................................................................ 4563
GetTaskById(string) ............................................................................................................... 4563

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

RecreateDeletedTasks() ......................................................................................................... 4563

Refresh() ............................................................................................................................... 4564
Update() ............................................................................................................................... 4564
TaskGroupTemplate .................................................................................................................... 4564
AnalysisType ......................................................................................................................... 4565
Attributes ............................................................................................................................. 4565
Category .............................................................................................................................. 4566
DisplayName ........................................................................................................................ 4566
ExcludedTaskTemplates ........................................................................................................ 4566
HeaderText ........................................................................................................................... 4566
ImageName .......................................................................................................................... 4566
InternalObject ...................................................................................................................... 4566
IsBeta ................................................................................................................................... 4567
IsDeletable ........................................................................................................................... 4567
IsParametric .......................................................................................................................... 4567
Name ................................................................................................................................... 4567
Physics ................................................................................................................................. 4567
PostCreationSteps ................................................................................................................. 4567
RequiredTaskTemplates ........................................................................................................ 4568
Solver ................................................................................................................................... 4568
TaskGroupHelpId .................................................................................................................. 4568
TaskGroupType ..................................................................................................................... 4568
TaskGroupTypeAbbreviation ................................................................................................. 4568
TaskNames ........................................................................................................................... 4568
TaskTemplates ...................................................................................................................... 4569
ToolboxGroup ....................................................................................................................... 4569
ToolTipHelpId ....................................................................................................................... 4569
ToolTipText ........................................................................................................................... 4569
Visible .................................................................................................................................. 4569
TaskTemplate .............................................................................................................................. 4570
AboutToResetCommandName .............................................................................................. 4574
AvailableTransferTasks .......................................................................................................... 4574
CanDuplicateQueryName ..................................................................................................... 4574
CanUseTransferDataQueryName ........................................................................................... 4574
CleanCommandName ........................................................................................................... 4574
ComponentImageName ....................................................................................................... 4575
ComponentPropertyDataQueryName ................................................................................... 4575
CreateAllProvidesConnectionsToNewSystem ......................................................................... 4575
CreatingCommandName ...................................................................................................... 4575
DataGroupStatusQueryName ................................................................................................ 4575
DataGroupUpdateCommandName ....................................................................................... 4575
DataSourceListChangedCommandName .............................................................................. 4576
DefaultTransferName ............................................................................................................ 4576
DeletingCommandName ...................................................................................................... 4576
DesignPointReportContentCreationCommandName ............................................................. 4576
DisplayName ........................................................................................................................ 4576
DontShareByDefault ............................................................................................................. 4576
DuplicateGroup .................................................................................................................... 4577
DuplicateTaskCommandName .............................................................................................. 4577
EditorInitiatedRemoteUpdateInfoQueryName ....................................................................... 4577
EquivalentInputs ................................................................................................................... 4577

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

GetEnvironmentForRsmDpUpdateQueryName ...................................................................... 4577

GetRemoteUpdateMonitorFilesQueryName .......................................................................... 4578
IncludeInPartialUpdate ......................................................................................................... 4578
InternalObject ...................................................................................................................... 4578
IsAim .................................................................................................................................... 4578
IsDeletable ........................................................................................................................... 4578
IsDisabled ............................................................................................................................. 4578
IsReplaceable ........................................................................................................................ 4579
IsReplaceableWithSharing ..................................................................................................... 4579
IsResults ............................................................................................................................... 4579
IsShareable ........................................................................................................................... 4579
Name ................................................................................................................................... 4579
OutputTypes ......................................................................................................................... 4580
RefreshAfterPartialUpdate ..................................................................................................... 4580
RefreshCommandName ........................................................................................................ 4580
RemoteSolvePermissionsQueryName .................................................................................... 4580
ReportContentCreationCommandName ............................................................................... 4580
RequiredInputTypes .............................................................................................................. 4580
ResetCommandName ........................................................................................................... 4581
ShowOptionToAlwaysBePartOfDpUpdate ............................................................................. 4581
Solver ................................................................................................................................... 4581
SubTasks ............................................................................................................................... 4581
SubTaskStatusQueryName .................................................................................................... 4581
TaskStatusQueryName .......................................................................................................... 4581
TaskTypeAbbreviation ........................................................................................................... 4582
UpdateCommandName ........................................................................................................ 4582
ValidationCodes .................................................................................................................... 4582
WillBePendingUponUpdateQueryName ................................................................................ 4582
WillBeUpdatedViaRsmQueryName ........................................................................................ 4582

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cclvii
 Release 2022 R2 - © 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 ............................................................................................................................................... 13
12. Members ............................................................................................................................................... 13
13. Members ............................................................................................................................................... 15
14. Members ............................................................................................................................................... 15
15. Members ............................................................................................................................................... 16
16. Members ............................................................................................................................................... 17
17. Members ............................................................................................................................................... 21
18. Members ............................................................................................................................................... 23
19. Members ............................................................................................................................................... 23
20. Members ............................................................................................................................................... 24
21. Members ............................................................................................................................................... 25
22. Members ............................................................................................................................................... 27
23. Members ............................................................................................................................................... 29
24. Members ............................................................................................................................................... 29
25. Members ............................................................................................................................................... 37
26. Members ............................................................................................................................................... 37
27. Members ............................................................................................................................................... 38
28. Members ............................................................................................................................................... 40
29. Members ............................................................................................................................................... 41
30. Members ............................................................................................................................................... 44
31. Members ............................................................................................................................................... 45
32. Members ............................................................................................................................................... 46
33. Members ............................................................................................................................................... 47
34. Members ............................................................................................................................................... 48
35. Members ............................................................................................................................................... 50
36. Members ............................................................................................................................................... 53
37. Members ............................................................................................................................................... 55
38. Members ............................................................................................................................................... 55
39. Members ............................................................................................................................................... 56
40. Members ............................................................................................................................................... 56
41. Members ............................................................................................................................................... 57
42. Members ............................................................................................................................................... 59
43. Members ............................................................................................................................................... 60
44. Members ............................................................................................................................................... 62
45. Members ............................................................................................................................................... 62
46. Members ............................................................................................................................................... 64
47. Members ............................................................................................................................................... 64
48. Members ............................................................................................................................................... 65
49. Members ............................................................................................................................................... 66

Release 2022 R2 - © 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 ............................................................................................................................................... 67

51. Members ............................................................................................................................................... 69
52. Members ............................................................................................................................................... 74
53. Members ............................................................................................................................................... 76
54. Members ............................................................................................................................................... 77
55. Members ............................................................................................................................................... 79
56. Members ............................................................................................................................................... 80
57. Members ............................................................................................................................................... 81
58. Members ............................................................................................................................................... 81
59. Members ............................................................................................................................................... 82
60. Members ............................................................................................................................................... 83
61. Members ............................................................................................................................................... 84
62. Members ............................................................................................................................................... 85
63. Members ............................................................................................................................................... 86
64. Members ............................................................................................................................................... 88
65. Members ............................................................................................................................................... 88
66. Members ............................................................................................................................................... 89
67. Members ............................................................................................................................................... 89
68. Members ............................................................................................................................................... 91
69. Members ............................................................................................................................................... 92
70. Members ............................................................................................................................................... 93
71. Members ............................................................................................................................................... 93
72. Members ............................................................................................................................................... 97
73. Members ............................................................................................................................................... 97
74. Members ............................................................................................................................................. 103
75. Members ............................................................................................................................................. 103
76. Members ............................................................................................................................................. 105
77. Members ............................................................................................................................................. 106
78. Members ............................................................................................................................................. 106
79. Members ............................................................................................................................................. 107
80. Members ............................................................................................................................................. 108
81. Members ............................................................................................................................................. 109
82. Members ............................................................................................................................................. 109
83. Members ............................................................................................................................................. 111
84. Members ............................................................................................................................................. 115
85. Members ............................................................................................................................................. 116
86. Members ............................................................................................................................................. 119
87. Members ............................................................................................................................................. 122
88. Members ............................................................................................................................................. 129
89. Members ............................................................................................................................................. 129
90. Members ............................................................................................................................................. 131
91. Members ............................................................................................................................................. 131
92. Members ............................................................................................................................................. 132
93. Members ............................................................................................................................................. 135
94. Members ............................................................................................................................................. 140
95. Members ............................................................................................................................................. 145
96. Members ............................................................................................................................................. 147
97. Members ............................................................................................................................................. 182
98. Members ............................................................................................................................................. 186
99. Members ............................................................................................................................................. 191
100. Members ........................................................................................................................................... 197

Release 2022 R2 - © 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 ........................................................................................................................................... 216

102. Members ........................................................................................................................................... 218
103. Members ........................................................................................................................................... 220
104. Members ........................................................................................................................................... 225
105. Members ........................................................................................................................................... 226
106. Members ........................................................................................................................................... 228
107. Members ........................................................................................................................................... 229
108. Members ........................................................................................................................................... 238
109. Members ........................................................................................................................................... 240
110. Members ........................................................................................................................................... 241
111. Members ........................................................................................................................................... 243
112. Members ........................................................................................................................................... 245
113. Members ........................................................................................................................................... 247
114. Members ........................................................................................................................................... 252
115. Members ........................................................................................................................................... 257
116. Members ........................................................................................................................................... 263
117. Members ........................................................................................................................................... 264
118. Members ........................................................................................................................................... 267
119. Members ........................................................................................................................................... 268
120. Members ........................................................................................................................................... 270
121. Members ........................................................................................................................................... 275
122. Members ........................................................................................................................................... 279
123. Members ........................................................................................................................................... 282
124. Members ........................................................................................................................................... 284
125. Members ........................................................................................................................................... 287
126. Members ........................................................................................................................................... 290
127. Members ........................................................................................................................................... 305
128. Members ........................................................................................................................................... 308
129. Members ........................................................................................................................................... 311
130. Members ........................................................................................................................................... 317
131. Members ........................................................................................................................................... 321
132. Members ........................................................................................................................................... 322
133. Members ........................................................................................................................................... 326
134. Members ........................................................................................................................................... 331
135. Members ........................................................................................................................................... 333
136. Members ........................................................................................................................................... 335
137. Members ........................................................................................................................................... 338
138. Members ........................................................................................................................................... 339
139. Members ........................................................................................................................................... 341
140. Members ........................................................................................................................................... 343
141. Members ........................................................................................................................................... 348
142. Members ........................................................................................................................................... 354
143. Members ........................................................................................................................................... 359
144. Members ........................................................................................................................................... 361
145. Members ........................................................................................................................................... 368
146. Members ........................................................................................................................................... 372
147. Members ........................................................................................................................................... 376
148. Members ........................................................................................................................................... 378
149. Members ........................................................................................................................................... 381
150. Members ........................................................................................................................................... 390
151. Members ........................................................................................................................................... 394

Release 2022 R2 - © 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 ........................................................................................................................................... 404

153. Members ........................................................................................................................................... 407
154. Members ........................................................................................................................................... 412
155. Members ........................................................................................................................................... 417
156. Members ........................................................................................................................................... 421
157. Members ........................................................................................................................................... 424
158. Members ........................................................................................................................................... 428
159. Members ........................................................................................................................................... 448
160. Members ........................................................................................................................................... 452
161. Members ........................................................................................................................................... 457
162. Members ........................................................................................................................................... 461
163. Members ........................................................................................................................................... 463
164. Members ........................................................................................................................................... 466
165. Members ........................................................................................................................................... 469
166. Members ........................................................................................................................................... 470
167. Members ........................................................................................................................................... 473
168. Members ........................................................................................................................................... 476
169. Members ........................................................................................................................................... 481
170. Members ........................................................................................................................................... 483
171. Members ........................................................................................................................................... 491
172. Members ........................................................................................................................................... 492
173. Members ........................................................................................................................................... 493
174. Members ........................................................................................................................................... 494
175. Members ........................................................................................................................................... 495
176. Members ........................................................................................................................................... 496
177. Members ........................................................................................................................................... 498
178. Members ........................................................................................................................................... 499
179. Members ........................................................................................................................................... 501
180. Members ........................................................................................................................................... 502
181. Members ........................................................................................................................................... 505
182. Members ........................................................................................................................................... 506
183. Members ........................................................................................................................................... 507
184. Members ........................................................................................................................................... 509
185. Members ........................................................................................................................................... 510
186. Members ........................................................................................................................................... 511
187. Members ........................................................................................................................................... 512
188. Members ........................................................................................................................................... 524
189. Members ........................................................................................................................................... 528
190. Members ........................................................................................................................................... 532
191. Members ........................................................................................................................................... 542
192. Members ........................................................................................................................................... 547
193. Members ........................................................................................................................................... 552
194. Members ........................................................................................................................................... 554
195. Members ........................................................................................................................................... 556
196. Members ........................................................................................................................................... 559
197. Members ........................................................................................................................................... 565
198. Members ........................................................................................................................................... 568
199. Members ........................................................................................................................................... 572
200. Members ........................................................................................................................................... 577
201. Members ........................................................................................................................................... 580
202. Members ........................................................................................................................................... 585

Release 2022 R2 - © 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 ........................................................................................................................................... 587

204. Members ........................................................................................................................................... 590
205. Members ........................................................................................................................................... 596
206. Members ........................................................................................................................................... 599
207. Members ........................................................................................................................................... 604
208. Members ........................................................................................................................................... 611
209. Members ........................................................................................................................................... 619
210. Members ........................................................................................................................................... 623
211. Members ........................................................................................................................................... 653
212. Members ........................................................................................................................................... 656
213. Members ........................................................................................................................................... 663
214. Members ........................................................................................................................................... 666
215. Members ........................................................................................................................................... 669
216. Members ........................................................................................................................................... 674
217. Members ........................................................................................................................................... 678
218. Members ........................................................................................................................................... 679
219. Members ........................................................................................................................................... 684
220. Members ........................................................................................................................................... 687
221. Members ........................................................................................................................................... 692
222. Members ........................................................................................................................................... 697
223. Members ........................................................................................................................................... 701
224. Members ........................................................................................................................................... 710
225. Members ........................................................................................................................................... 715
226. Members ........................................................................................................................................... 717
227. Members ........................................................................................................................................... 720
228. Members ........................................................................................................................................... 724
229. Members ........................................................................................................................................... 733
230. Members ........................................................................................................................................... 739
231. Members ........................................................................................................................................... 743
232. Members ........................................................................................................................................... 751
233. Members ........................................................................................................................................... 753
234. Members ........................................................................................................................................... 754
235. Members ........................................................................................................................................... 761
236. Members ........................................................................................................................................... 764
237. Members ........................................................................................................................................... 768
238. Members ........................................................................................................................................... 770
239. Members ........................................................................................................................................... 772
240. Members ........................................................................................................................................... 775
241. Members ........................................................................................................................................... 777
242. Members ........................................................................................................................................... 781
243. Members ........................................................................................................................................... 788
244. Members ........................................................................................................................................... 790
245. Members ........................................................................................................................................... 792
246. Members ........................................................................................................................................... 794
247. Members ........................................................................................................................................... 796
248. Members ........................................................................................................................................... 798
249. Members ........................................................................................................................................... 806
250. Members ........................................................................................................................................... 809
251. Members ........................................................................................................................................... 812
252. Members ........................................................................................................................................... 816
253. Members ........................................................................................................................................... 821

Release 2022 R2 - © 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 ........................................................................................................................................... 828

255. Members ........................................................................................................................................... 840
256. Members ........................................................................................................................................... 847
257. Members ........................................................................................................................................... 852
258. Members ........................................................................................................................................... 856
259. Members ........................................................................................................................................... 932
260. Members ........................................................................................................................................... 947
261. Members ........................................................................................................................................... 956
262. Members ........................................................................................................................................... 980
263. Members ........................................................................................................................................... 987
264. Members ........................................................................................................................................... 989
265. Members ........................................................................................................................................... 992
266. Members ........................................................................................................................................... 996
267. Members ......................................................................................................................................... 1000
268. Members ......................................................................................................................................... 1005
269. Members ......................................................................................................................................... 1010
270. Members ......................................................................................................................................... 1011
271. Members ......................................................................................................................................... 1014
272. Members ......................................................................................................................................... 1019
273. Members ......................................................................................................................................... 1022
274. Members ......................................................................................................................................... 1024
275. Members ......................................................................................................................................... 1025
276. Members ......................................................................................................................................... 1026
277. Members ......................................................................................................................................... 1029
278. Members ......................................................................................................................................... 1034
279. Members ......................................................................................................................................... 1041
280. Members ......................................................................................................................................... 1044
281. Members ......................................................................................................................................... 1045
282. Members ......................................................................................................................................... 1048
283. Members ......................................................................................................................................... 1052
284. Members ......................................................................................................................................... 1063
285. Members ......................................................................................................................................... 1066
286. Members ......................................................................................................................................... 1071
287. Members ......................................................................................................................................... 1071
288. Members ......................................................................................................................................... 1072
289. Members ......................................................................................................................................... 1072
290. Members ......................................................................................................................................... 1075
291. Members ......................................................................................................................................... 1075
292. Members ......................................................................................................................................... 1077
293. Members ......................................................................................................................................... 1077
294. Members ......................................................................................................................................... 1078
295. Members ......................................................................................................................................... 1079
296. Members ......................................................................................................................................... 1081
297. Members ......................................................................................................................................... 1082
298. Members ......................................................................................................................................... 1083
299. Members ......................................................................................................................................... 1084
300. Members ......................................................................................................................................... 1086
301. Members ......................................................................................................................................... 1087
302. Members ......................................................................................................................................... 1088
303. Members ......................................................................................................................................... 1089
304. Members ......................................................................................................................................... 1090

Release 2022 R2 - © 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 ......................................................................................................................................... 1091

306. Members ......................................................................................................................................... 1092
307. Members ......................................................................................................................................... 1092
308. Members ......................................................................................................................................... 1093
309. Members ......................................................................................................................................... 1094
310. Members ......................................................................................................................................... 1096
311. Members ......................................................................................................................................... 1097
312. Members ......................................................................................................................................... 1098
313. Members ......................................................................................................................................... 1099
314. Members ......................................................................................................................................... 1099
315. Members ......................................................................................................................................... 1100
316. Members ......................................................................................................................................... 1101
317. Members ......................................................................................................................................... 1102
318. Members ......................................................................................................................................... 1103
319. Members ......................................................................................................................................... 1104
320. Members ......................................................................................................................................... 1104
321. Members ......................................................................................................................................... 1105
322. Members ......................................................................................................................................... 1106
323. Members ......................................................................................................................................... 1107
324. Members ......................................................................................................................................... 1108
325. Members ......................................................................................................................................... 1110
326. Members ......................................................................................................................................... 1111
327. Members ......................................................................................................................................... 1111
328. Members ......................................................................................................................................... 1112
329. Members ......................................................................................................................................... 1113
330. Members ......................................................................................................................................... 1114
331. Members ......................................................................................................................................... 1115
332. Members ......................................................................................................................................... 1115
333. Members ......................................................................................................................................... 1116
334. Members ......................................................................................................................................... 1117
335. Members ......................................................................................................................................... 1118
336. Members ......................................................................................................................................... 1120
337. Members ......................................................................................................................................... 1120
338. Members ......................................................................................................................................... 1122
339. Members ......................................................................................................................................... 1123
340. Members ......................................................................................................................................... 1125
341. Members ......................................................................................................................................... 1126
342. Members ......................................................................................................................................... 1127
343. Members ......................................................................................................................................... 1127
344. Members ......................................................................................................................................... 1128
345. Members ......................................................................................................................................... 1129
346. Members ......................................................................................................................................... 1129
347. Members ......................................................................................................................................... 1130
348. Members ......................................................................................................................................... 1131
349. Members ......................................................................................................................................... 1132
350. Members ......................................................................................................................................... 1135
351. Members ......................................................................................................................................... 1138
352. Members ......................................................................................................................................... 1142
353. Members ......................................................................................................................................... 1145
354. Members ......................................................................................................................................... 1147
355. Members ......................................................................................................................................... 1151

Release 2022 R2 - © 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 ......................................................................................................................................... 1155

357. Members ......................................................................................................................................... 1158
358. Members ......................................................................................................................................... 1162
359. Members ......................................................................................................................................... 1166
360. Members ......................................................................................................................................... 1170
361. Members ......................................................................................................................................... 1174
362. Members ......................................................................................................................................... 1188
363. Members ......................................................................................................................................... 1200
364. Members ......................................................................................................................................... 1203
365. Members ......................................................................................................................................... 1207
366. Members ......................................................................................................................................... 1211
367. Members ......................................................................................................................................... 1213
368. Members ......................................................................................................................................... 1216
369. Members ......................................................................................................................................... 1218
370. Members ......................................................................................................................................... 1226
371. Members ......................................................................................................................................... 1241
372. Members ......................................................................................................................................... 1244
373. Members ......................................................................................................................................... 1251
374. Members ......................................................................................................................................... 1251
375. Members ......................................................................................................................................... 1255
376. Members ......................................................................................................................................... 1258
377. Members ......................................................................................................................................... 1262
378. Members ......................................................................................................................................... 1265
379. Members ......................................................................................................................................... 1269
380. Members ......................................................................................................................................... 1270
381. Members ......................................................................................................................................... 1274
382. Members ......................................................................................................................................... 1280
383. Members ......................................................................................................................................... 1284
384. Members ......................................................................................................................................... 1289
385. Members ......................................................................................................................................... 1294
386. Members ......................................................................................................................................... 1299
387. Members ......................................................................................................................................... 1304
388. Members ......................................................................................................................................... 1309
389. Members ......................................................................................................................................... 1314
390. Members ......................................................................................................................................... 1318
391. Members ......................................................................................................................................... 1324
392. Members ......................................................................................................................................... 1329
393. Members ......................................................................................................................................... 1334
394. Members ......................................................................................................................................... 1338
395. Members ......................................................................................................................................... 1343
396. Members ......................................................................................................................................... 1348
397. Members ......................................................................................................................................... 1354
398. Members ......................................................................................................................................... 1359
399. Members ......................................................................................................................................... 1366
400. Members ......................................................................................................................................... 1373
401. Members ......................................................................................................................................... 1373
402. Members ......................................................................................................................................... 1382
403. Members ......................................................................................................................................... 1387
404. Members ......................................................................................................................................... 1393
405. Members ......................................................................................................................................... 1398
406. Members ......................................................................................................................................... 1403

Release 2022 R2 - © 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 ......................................................................................................................................... 1409

408. Members ......................................................................................................................................... 1414
409. Members ......................................................................................................................................... 1420
410. Members ......................................................................................................................................... 1425
411. Members ......................................................................................................................................... 1430
412. Members ......................................................................................................................................... 1435
413. Members ......................................................................................................................................... 1441
414. Members ......................................................................................................................................... 1442
415. Members ......................................................................................................................................... 1446
416. Members ......................................................................................................................................... 1450
417. Members ......................................................................................................................................... 1454
418. Members ......................................................................................................................................... 1458
419. Members ......................................................................................................................................... 1462
420. Members ......................................................................................................................................... 1466
421. Members ......................................................................................................................................... 1470
422. Members ......................................................................................................................................... 1474
423. Members ......................................................................................................................................... 1478
424. Members ......................................................................................................................................... 1482
425. Members ......................................................................................................................................... 1486
426. Members ......................................................................................................................................... 1490
427. Members ......................................................................................................................................... 1494
428. Members ......................................................................................................................................... 1498
429. Members ......................................................................................................................................... 1503
430. Members ......................................................................................................................................... 1503
431. Members ......................................................................................................................................... 1509
432. Members ......................................................................................................................................... 1514
433. Members ......................................................................................................................................... 1519
434. Members ......................................................................................................................................... 1523
435. Members ......................................................................................................................................... 1528
436. Members ......................................................................................................................................... 1533
437. Members ......................................................................................................................................... 1537
438. Members ......................................................................................................................................... 1542
439. Members ......................................................................................................................................... 1547
440. Members ......................................................................................................................................... 1547
441. Members ......................................................................................................................................... 1553
442. Members ......................................................................................................................................... 1559
443. Members ......................................................................................................................................... 1565
444. Members ......................................................................................................................................... 1571
445. Members ......................................................................................................................................... 1577
446. Members ......................................................................................................................................... 1582
447. Members ......................................................................................................................................... 1588
448. Members ......................................................................................................................................... 1594
449. Members ......................................................................................................................................... 1603
450. Members ......................................................................................................................................... 1603
451. Members ......................................................................................................................................... 1607
452. Members ......................................................................................................................................... 1611
453. Members ......................................................................................................................................... 1615
454. Members ......................................................................................................................................... 1619
455. Members ......................................................................................................................................... 1625
456. Members ......................................................................................................................................... 1625
457. Members ......................................................................................................................................... 1629

Release 2022 R2 - © 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 ......................................................................................................................................... 1633

459. Members ......................................................................................................................................... 1637
460. Members ......................................................................................................................................... 1641
461. Members ......................................................................................................................................... 1645
462. Members ......................................................................................................................................... 1645
463. Members ......................................................................................................................................... 1649
464. Members ......................................................................................................................................... 1654
465. Members ......................................................................................................................................... 1658
466. Members ......................................................................................................................................... 1662
467. Members ......................................................................................................................................... 1666
468. Members ......................................................................................................................................... 1667
469. Members ......................................................................................................................................... 1668
470. Members ......................................................................................................................................... 1672
471. Members ......................................................................................................................................... 1676
472. Members ......................................................................................................................................... 1680
473. Members ......................................................................................................................................... 1684
474. Members ......................................................................................................................................... 1689
475. Members ......................................................................................................................................... 1689
476. Members ......................................................................................................................................... 1694
477. Members ......................................................................................................................................... 1698
478. Members ......................................................................................................................................... 1703
479. Members ......................................................................................................................................... 1708
480. Members ......................................................................................................................................... 1712
481. Members ......................................................................................................................................... 1716
482. Members ......................................................................................................................................... 1720
483. Members ......................................................................................................................................... 1725
484. Members ......................................................................................................................................... 1731
485. Members ......................................................................................................................................... 1731
486. Members ......................................................................................................................................... 1735
487. Members ......................................................................................................................................... 1739
488. Members ......................................................................................................................................... 1743
489. Members ......................................................................................................................................... 1747
490. Members ......................................................................................................................................... 1751
491. Members ......................................................................................................................................... 1755
492. Members ......................................................................................................................................... 1758
493. Members ......................................................................................................................................... 1762
494. Members ......................................................................................................................................... 1767
495. Members ......................................................................................................................................... 1767
496. Members ......................................................................................................................................... 1771
497. Members ......................................................................................................................................... 1775
498. Members ......................................................................................................................................... 1779
499. Members ......................................................................................................................................... 1783
500. Members ......................................................................................................................................... 1787
501. Members ......................................................................................................................................... 1791
502. Members ......................................................................................................................................... 1795
503. Members ......................................................................................................................................... 1799
504. Members ......................................................................................................................................... 1803
505. Members ......................................................................................................................................... 1807
506. Members ......................................................................................................................................... 1811
507. Members ......................................................................................................................................... 1815
508. Members ......................................................................................................................................... 1818

Release 2022 R2 - © 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 ......................................................................................................................................... 1822

510. Members ......................................................................................................................................... 1827
511. Members ......................................................................................................................................... 1828
512. Members ......................................................................................................................................... 1834
513. Members ......................................................................................................................................... 1840
514. Members ......................................................................................................................................... 1846
515. Members ......................................................................................................................................... 1852
516. Members ......................................................................................................................................... 1859
517. Members ......................................................................................................................................... 1865
518. Members ......................................................................................................................................... 1871
519. Members ......................................................................................................................................... 1877
520. Members ......................................................................................................................................... 1883
521. Members ......................................................................................................................................... 1889
522. Members ......................................................................................................................................... 1896
523. Members ......................................................................................................................................... 1902
524. Members ......................................................................................................................................... 1908
525. Members ......................................................................................................................................... 1915
526. Members ......................................................................................................................................... 1921
527. Members ......................................................................................................................................... 1928
528. Members ......................................................................................................................................... 1935
529. Members ......................................................................................................................................... 1941
530. Members ......................................................................................................................................... 1947
531. Members ......................................................................................................................................... 1958
532. Members ......................................................................................................................................... 1964
533. Members ......................................................................................................................................... 1971
534. Members ......................................................................................................................................... 1971
535. Members ......................................................................................................................................... 1975
536. Members ......................................................................................................................................... 1979
537. Members ......................................................................................................................................... 1983
538. Members ......................................................................................................................................... 1987
539. Members ......................................................................................................................................... 1995
540. Members ......................................................................................................................................... 1999
541. Members ......................................................................................................................................... 2004
542. Members ......................................................................................................................................... 2009
543. Members ......................................................................................................................................... 2009
544. Members ......................................................................................................................................... 2013
545. Members ......................................................................................................................................... 2017
546. Members ......................................................................................................................................... 2022
547. Members ......................................................................................................................................... 2026
548. Members ......................................................................................................................................... 2030
549. Members ......................................................................................................................................... 2034
550. Members ......................................................................................................................................... 2038
551. Members ......................................................................................................................................... 2042
552. Members ......................................................................................................................................... 2047
553. Members ......................................................................................................................................... 2053
554. Members ......................................................................................................................................... 2053
555. Members ......................................................................................................................................... 2058
556. Members ......................................................................................................................................... 2062
557. Members ......................................................................................................................................... 2066
558. Members ......................................................................................................................................... 2070
559. Members ......................................................................................................................................... 2074

Release 2022 R2 - © 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 ......................................................................................................................................... 2078

561. Members ......................................................................................................................................... 2082
562. Members ......................................................................................................................................... 2087
563. Members ......................................................................................................................................... 2091
564. Members ......................................................................................................................................... 2097
565. Members ......................................................................................................................................... 2097
566. Members ......................................................................................................................................... 2101
567. Members ......................................................................................................................................... 2105
568. Members ......................................................................................................................................... 2109
569. Members ......................................................................................................................................... 2114
570. Members ......................................................................................................................................... 2119
571. Members ......................................................................................................................................... 2119
572. Members ......................................................................................................................................... 2125
573. Members ......................................................................................................................................... 2129
574. Members ......................................................................................................................................... 2131
575. Members ......................................................................................................................................... 2135
576. Members ......................................................................................................................................... 2138
577. Members ......................................................................................................................................... 2144
578. Members ......................................................................................................................................... 2148
579. Members ......................................................................................................................................... 2151
580. Members ......................................................................................................................................... 2155
581. Members ......................................................................................................................................... 2159
582. Members ......................................................................................................................................... 2162
583. Members ......................................................................................................................................... 2166
584. Members ......................................................................................................................................... 2170
585. Members ......................................................................................................................................... 2173
586. Members ......................................................................................................................................... 2177
587. Members ......................................................................................................................................... 2181
588. Members ......................................................................................................................................... 2184
589. Members ......................................................................................................................................... 2188
590. Members ......................................................................................................................................... 2192
591. Members ......................................................................................................................................... 2196
592. Members ......................................................................................................................................... 2199
593. Members ......................................................................................................................................... 2203
594. Members ......................................................................................................................................... 2207
595. Members ......................................................................................................................................... 2211
596. Members ......................................................................................................................................... 2214
597. Members ......................................................................................................................................... 2218
598. Members ......................................................................................................................................... 2222
599. Members ......................................................................................................................................... 2225
600. Members ......................................................................................................................................... 2229
601. Members ......................................................................................................................................... 2232
602. Members ......................................................................................................................................... 2236
603. Members ......................................................................................................................................... 2240
604. Members ......................................................................................................................................... 2244
605. Members ......................................................................................................................................... 2247
606. Members ......................................................................................................................................... 2251
607. Members ......................................................................................................................................... 2255
608. Members ......................................................................................................................................... 2258
609. Members ......................................................................................................................................... 2262
610. Members ......................................................................................................................................... 2265

Release 2022 R2 - © 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 ......................................................................................................................................... 2269

612. Members ......................................................................................................................................... 2272
613. Members ......................................................................................................................................... 2276
614. Members ......................................................................................................................................... 2280
615. Members ......................................................................................................................................... 2283
616. Members ......................................................................................................................................... 2287
617. Members ......................................................................................................................................... 2290
618. Members ......................................................................................................................................... 2294
619. Members ......................................................................................................................................... 2299
620. Members ......................................................................................................................................... 2303
621. Members ......................................................................................................................................... 2307
622. Members ......................................................................................................................................... 2312
623. Members ......................................................................................................................................... 2316
624. Members ......................................................................................................................................... 2319
625. Members ......................................................................................................................................... 2323
626. Members ......................................................................................................................................... 2326
627. Members ......................................................................................................................................... 2331
628. Members ......................................................................................................................................... 2334
629. Members ......................................................................................................................................... 2339
630. Members ......................................................................................................................................... 2342
631. Members ......................................................................................................................................... 2345
632. Members ......................................................................................................................................... 2349
633. Members ......................................................................................................................................... 2352
634. Members ......................................................................................................................................... 2356
635. Members ......................................................................................................................................... 2359
636. Members ......................................................................................................................................... 2363
637. Members ......................................................................................................................................... 2368
638. Members ......................................................................................................................................... 2371
639. Members ......................................................................................................................................... 2375
640. Members ......................................................................................................................................... 2378
641. Members ......................................................................................................................................... 2381
642. Members ......................................................................................................................................... 2385
643. Members ......................................................................................................................................... 2388
644. Members ......................................................................................................................................... 2393
645. Members ......................................................................................................................................... 2396
646. Members ......................................................................................................................................... 2401
647. Members ......................................................................................................................................... 2402
648. Members ......................................................................................................................................... 2405
649. Members ......................................................................................................................................... 2409
650. Members ......................................................................................................................................... 2412
651. Members ......................................................................................................................................... 2419
652. Members ......................................................................................................................................... 2428
653. Members ......................................................................................................................................... 2432
654. Members ......................................................................................................................................... 2438
655. Members ......................................................................................................................................... 2442
656. Members ......................................................................................................................................... 2448
657. Members ......................................................................................................................................... 2451
658. Members ......................................................................................................................................... 2455
659. Members ......................................................................................................................................... 2460
660. Members ......................................................................................................................................... 2464
661. Members ......................................................................................................................................... 2474

Release 2022 R2 - © 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 ......................................................................................................................................... 2478

663. Members ......................................................................................................................................... 2483
664. Members ......................................................................................................................................... 2487
665. Members ......................................................................................................................................... 2494
666. Members ......................................................................................................................................... 2497
667. Members ......................................................................................................................................... 2500
668. Members ......................................................................................................................................... 2506
669. Members ......................................................................................................................................... 2512
670. Members ......................................................................................................................................... 2515
671. Members ......................................................................................................................................... 2520
672. Members ......................................................................................................................................... 2524
673. Members ......................................................................................................................................... 2530
674. Members ......................................................................................................................................... 2533
675. Members ......................................................................................................................................... 2538
676. Members ......................................................................................................................................... 2542
677. Members ......................................................................................................................................... 2546
678. Members ......................................................................................................................................... 2551
679. Members ......................................................................................................................................... 2563
680. Members ......................................................................................................................................... 2568
681. Members ......................................................................................................................................... 2575
682. Members ......................................................................................................................................... 2584
683. Members ......................................................................................................................................... 2595
684. Members ......................................................................................................................................... 2599
685. Members ......................................................................................................................................... 2602
686. Members ......................................................................................................................................... 2605
687. Members ......................................................................................................................................... 2611
688. Members ......................................................................................................................................... 2612
689. Members ......................................................................................................................................... 2615
690. Members ......................................................................................................................................... 2619
691. Members ......................................................................................................................................... 2622
692. Members ......................................................................................................................................... 2625
693. Members ......................................................................................................................................... 2629
694. Members ......................................................................................................................................... 2633
695. Members ......................................................................................................................................... 2636
696. Members ......................................................................................................................................... 2640
697. Members ......................................................................................................................................... 2643
698. Members ......................................................................................................................................... 2647
699. Members ......................................................................................................................................... 2651
700. Members ......................................................................................................................................... 2656
701. Members ......................................................................................................................................... 2661
702. Members ......................................................................................................................................... 2664
703. Members ......................................................................................................................................... 2669
704. Members ......................................................................................................................................... 2672
705. Members ......................................................................................................................................... 2676
706. Members ......................................................................................................................................... 2679
707. Members ......................................................................................................................................... 2683
708. Members ......................................................................................................................................... 2687
709. Members ......................................................................................................................................... 2687
710. Members ......................................................................................................................................... 2692
711. Members ......................................................................................................................................... 2695
712. Members ......................................................................................................................................... 2701

Release 2022 R2 - © 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 ......................................................................................................................................... 2701

714. Members ......................................................................................................................................... 2705
715. Members ......................................................................................................................................... 2709
716. Members ......................................................................................................................................... 2713
717. Members ......................................................................................................................................... 2719
718. Members ......................................................................................................................................... 2719
719. Members ......................................................................................................................................... 2724
720. Members ......................................................................................................................................... 2728
721. Members ......................................................................................................................................... 2732
722. Members ......................................................................................................................................... 2736
723. Members ......................................................................................................................................... 2740
724. Members ......................................................................................................................................... 2744
725. Members ......................................................................................................................................... 2749
726. Members ......................................................................................................................................... 2750
727. Members ......................................................................................................................................... 2755
728. Members ......................................................................................................................................... 2759
729. Members ......................................................................................................................................... 2764
730. Members ......................................................................................................................................... 2769
731. Members ......................................................................................................................................... 2779
732. Members ......................................................................................................................................... 2785
733. Members ......................................................................................................................................... 2791
734. Members ......................................................................................................................................... 2796
735. Members ......................................................................................................................................... 2800
736. Members ......................................................................................................................................... 2804
737. Members ......................................................................................................................................... 2809
738. Members ......................................................................................................................................... 2813
739. Members ......................................................................................................................................... 2819
740. Members ......................................................................................................................................... 2824
741. Members ......................................................................................................................................... 2828
742. Members ......................................................................................................................................... 2833
743. Members ......................................................................................................................................... 2839
744. Members ......................................................................................................................................... 2840
745. Members ......................................................................................................................................... 2855
746. Members ......................................................................................................................................... 2858
747. Members ......................................................................................................................................... 2859
748. Members ......................................................................................................................................... 2861
749. Members ......................................................................................................................................... 2864
750. Members ......................................................................................................................................... 2866
751. Members ......................................................................................................................................... 2869
752. Members ......................................................................................................................................... 2872
753. Members ......................................................................................................................................... 2913
754. Members ......................................................................................................................................... 2917
755. Members ......................................................................................................................................... 2919
756. Members ......................................................................................................................................... 2920
757. Members ......................................................................................................................................... 2922
758. Members ......................................................................................................................................... 2930
759. Members ......................................................................................................................................... 2935
760. Members ......................................................................................................................................... 2938
761. Members ......................................................................................................................................... 2979
762. Members ......................................................................................................................................... 2980
763. Members ......................................................................................................................................... 2984

Release 2022 R2 - © 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 ......................................................................................................................................... 2988

765. Members ......................................................................................................................................... 2993
766. Members ......................................................................................................................................... 2998
767. Members ......................................................................................................................................... 3002
768. Members ......................................................................................................................................... 3007
769. Members ......................................................................................................................................... 3010
770. Members ......................................................................................................................................... 3014
771. Members ......................................................................................................................................... 3017
772. Members ......................................................................................................................................... 3021
773. Members ......................................................................................................................................... 3024
774. Members ......................................................................................................................................... 3028
775. Members ......................................................................................................................................... 3031
776. Members ......................................................................................................................................... 3045
777. Members ......................................................................................................................................... 3057
778. Members ......................................................................................................................................... 3060
779. Members ......................................................................................................................................... 3064
780. Members ......................................................................................................................................... 3068
781. Members ......................................................................................................................................... 3073
782. Members ......................................................................................................................................... 3076
783. Members ......................................................................................................................................... 3081
784. Members ......................................................................................................................................... 3085
785. Members ......................................................................................................................................... 3089
786. Members ......................................................................................................................................... 3093
787. Members ......................................................................................................................................... 3093
788. Members ......................................................................................................................................... 3101
789. Members ......................................................................................................................................... 3102
790. Members ......................................................................................................................................... 3107
791. Members ......................................................................................................................................... 3117
792. Members ......................................................................................................................................... 3127
793. Members ......................................................................................................................................... 3134
794. Members ......................................................................................................................................... 3140
795. Members ......................................................................................................................................... 3150
796. Members ......................................................................................................................................... 3158
797. Members ......................................................................................................................................... 3182
798. Members ......................................................................................................................................... 3186
799. Members ......................................................................................................................................... 3204
800. Members ......................................................................................................................................... 3212
801. Members ......................................................................................................................................... 3218
802. Members ......................................................................................................................................... 3231
803. Members ......................................................................................................................................... 3234
804. Members ......................................................................................................................................... 3241
805. Members ......................................................................................................................................... 3242
806. Members ......................................................................................................................................... 3244
807. Members ......................................................................................................................................... 3248
808. Members ......................................................................................................................................... 3250
809. Members ......................................................................................................................................... 3251
810. Members ......................................................................................................................................... 3253
811. Members ......................................................................................................................................... 3255
812. Members ......................................................................................................................................... 3260
813. Members ......................................................................................................................................... 3263
814. Members ......................................................................................................................................... 3265

Release 2022 R2 - © 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 ......................................................................................................................................... 3266

816. Members ......................................................................................................................................... 3268
817. Members ......................................................................................................................................... 3273
818. Members ......................................................................................................................................... 3274
819. Members ......................................................................................................................................... 3275
820. Members ......................................................................................................................................... 3277
821. Members ......................................................................................................................................... 3278
822. Members ......................................................................................................................................... 3281
823. Members ......................................................................................................................................... 3284
824. Members ......................................................................................................................................... 3285
825. Members ......................................................................................................................................... 3287
826. Members ......................................................................................................................................... 3288
827. Members ......................................................................................................................................... 3293
828. Members ......................................................................................................................................... 3298
829. Members ......................................................................................................................................... 3302
830. Members ......................................................................................................................................... 3309
831. Members ......................................................................................................................................... 3311
832. Members ......................................................................................................................................... 3314
833. Members ......................................................................................................................................... 3316
834. Members ......................................................................................................................................... 3322
835. Members ......................................................................................................................................... 3325
836. Members ......................................................................................................................................... 3329
837. Members ......................................................................................................................................... 3332
838. Members ......................................................................................................................................... 3334
839. Members ......................................................................................................................................... 3336
840. Members ......................................................................................................................................... 3344
841. Members ......................................................................................................................................... 3349
842. Members ......................................................................................................................................... 3351
843. Members ......................................................................................................................................... 3352
844. Members ......................................................................................................................................... 3354
845. Members ......................................................................................................................................... 3357
846. Members ......................................................................................................................................... 3362
847. Members ......................................................................................................................................... 3364
848. Members ......................................................................................................................................... 3366
849. Members ......................................................................................................................................... 3367
850. Members ......................................................................................................................................... 3376
851. Members ......................................................................................................................................... 3377
852. Members ......................................................................................................................................... 3383
853. Members ......................................................................................................................................... 3387
854. Members ......................................................................................................................................... 3390
855. Members ......................................................................................................................................... 3394
856. Members ......................................................................................................................................... 3399
857. Members ......................................................................................................................................... 3401
858. Members ......................................................................................................................................... 3403
859. Members ......................................................................................................................................... 3405
860. Members ......................................................................................................................................... 3411
861. Members ......................................................................................................................................... 3415
862. Members ......................................................................................................................................... 3418
863. Members ......................................................................................................................................... 3423
864. Members ......................................................................................................................................... 3430
865. Members ......................................................................................................................................... 3431

Release 2022 R2 - © 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 ......................................................................................................................................... 3433

867. Members ......................................................................................................................................... 3442
868. Members ......................................................................................................................................... 3447
869. Members ......................................................................................................................................... 3453
870. Members ......................................................................................................................................... 3457
871. Members ......................................................................................................................................... 3461
872. Members ......................................................................................................................................... 3463
873. Members ......................................................................................................................................... 3471
874. Members ......................................................................................................................................... 3473
875. Members ......................................................................................................................................... 3477
876. Members ......................................................................................................................................... 3481
877. Members ......................................................................................................................................... 3482
878. Members ......................................................................................................................................... 3490
879. Members ......................................................................................................................................... 3492
880. Members ......................................................................................................................................... 3493
881. Members ......................................................................................................................................... 3494
882. Members ......................................................................................................................................... 3498
883. Members ......................................................................................................................................... 3499
884. Members ......................................................................................................................................... 3504
885. Members ......................................................................................................................................... 3511
886. Members ......................................................................................................................................... 3520
887. Members ......................................................................................................................................... 3526
888. Members ......................................................................................................................................... 3530
889. Members ......................................................................................................................................... 3533
890. Members ......................................................................................................................................... 3537
891. Members ......................................................................................................................................... 3539
892. Members ......................................................................................................................................... 3540
893. Members ......................................................................................................................................... 3546
894. Members ......................................................................................................................................... 3548
895. Members ......................................................................................................................................... 3549
896. Members ......................................................................................................................................... 3551
897. Members ......................................................................................................................................... 3554
898. Members ......................................................................................................................................... 3559
899. Members ......................................................................................................................................... 3563
900. Members ......................................................................................................................................... 3564
901. Members ......................................................................................................................................... 3567
902. Members ......................................................................................................................................... 3569
903. Members ......................................................................................................................................... 3571
904. Members ......................................................................................................................................... 3571
905. Members ......................................................................................................................................... 3575
906. Members ......................................................................................................................................... 3680
907. Members ......................................................................................................................................... 3716
908. Members ......................................................................................................................................... 3728
909. Members ......................................................................................................................................... 3735
910. Members ......................................................................................................................................... 3736
911. Members ......................................................................................................................................... 3748
912. Members ......................................................................................................................................... 3755
913. Members ......................................................................................................................................... 3762
914. Members ......................................................................................................................................... 3767
915. Members ......................................................................................................................................... 3772
916. Members ......................................................................................................................................... 3775

Release 2022 R2 - © 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 ......................................................................................................................................... 3775

918. Members ......................................................................................................................................... 3778
919. Members ......................................................................................................................................... 3785
920. Members ......................................................................................................................................... 3785
921. Members ......................................................................................................................................... 3786
922. Members ......................................................................................................................................... 3788
923. Members ......................................................................................................................................... 3791
924. Members ......................................................................................................................................... 3791
925. Members ......................................................................................................................................... 3793
926. Members ......................................................................................................................................... 3793
927. Members ......................................................................................................................................... 3795
928. Members ......................................................................................................................................... 3796
929. Members ......................................................................................................................................... 3798
930. Members ......................................................................................................................................... 3801
931. Members ......................................................................................................................................... 3803
932. Members ......................................................................................................................................... 3803
933. Members ......................................................................................................................................... 3805
934. Members ......................................................................................................................................... 3805
935. Members ......................................................................................................................................... 3807
936. Members ......................................................................................................................................... 3807
937. Members ......................................................................................................................................... 3809
938. Members ......................................................................................................................................... 3809
939. Members ......................................................................................................................................... 3810
940. Members ......................................................................................................................................... 3811
941. Members ......................................................................................................................................... 3815
942. Members ......................................................................................................................................... 3816
943. Members ......................................................................................................................................... 3817
944. Members ......................................................................................................................................... 3819
945. Members ......................................................................................................................................... 3822
946. Members ......................................................................................................................................... 3823
947. Members ......................................................................................................................................... 3826
948. Members ......................................................................................................................................... 3828
949. Members ......................................................................................................................................... 3830
950. Members ......................................................................................................................................... 3832
951. Members ......................................................................................................................................... 3837
952. Members ......................................................................................................................................... 3837
953. Members ......................................................................................................................................... 3843
954. Members ......................................................................................................................................... 3851
955. Members ......................................................................................................................................... 3852
956. Members ......................................................................................................................................... 3852
957. Members ......................................................................................................................................... 3854
958. Members ......................................................................................................................................... 3855
959. Members ......................................................................................................................................... 3856
960. Members ......................................................................................................................................... 3858
961. Members ......................................................................................................................................... 3862
962. Members ......................................................................................................................................... 3864
963. Members ......................................................................................................................................... 3865
964. Members ......................................................................................................................................... 3866
965. Members ......................................................................................................................................... 3866
966. Members ......................................................................................................................................... 3869
967. Members ......................................................................................................................................... 3869

Release 2022 R2 - © 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 ......................................................................................................................................... 3873

969. Members ......................................................................................................................................... 3875
970. Members ......................................................................................................................................... 3876
971. Members ......................................................................................................................................... 3879
972. Members ......................................................................................................................................... 3879
973. Members ......................................................................................................................................... 3880
974. Members ......................................................................................................................................... 3881
975. Members ......................................................................................................................................... 3881
976. Members ......................................................................................................................................... 3882
977. Members ......................................................................................................................................... 3888
978. Members ......................................................................................................................................... 3889
979. Members ......................................................................................................................................... 3891
980. Members ......................................................................................................................................... 3892
981. Members ......................................................................................................................................... 3893
982. Members ......................................................................................................................................... 3894
983. Members ......................................................................................................................................... 3899
984. Members ......................................................................................................................................... 3899
985. Members ......................................................................................................................................... 3905
986. Members ......................................................................................................................................... 3907
987. Members ......................................................................................................................................... 3911
988. Members ......................................................................................................................................... 3912
989. Members ......................................................................................................................................... 3912
990. Members ......................................................................................................................................... 3913
991. Members ......................................................................................................................................... 3914
992. Members ......................................................................................................................................... 3914
993. Members ......................................................................................................................................... 3915
994. Members ......................................................................................................................................... 3916
995. Members ......................................................................................................................................... 3917
996. Members ......................................................................................................................................... 3917
997. Members ......................................................................................................................................... 3918
998. Members ......................................................................................................................................... 3919
999. Members ......................................................................................................................................... 3920
1000. Members ....................................................................................................................................... 3920
1001. Members ....................................................................................................................................... 3921
1002. Members ....................................................................................................................................... 3921
1003. Members ....................................................................................................................................... 3923
1004. Members ....................................................................................................................................... 3925
1005. Members ....................................................................................................................................... 3925
1006. Members ....................................................................................................................................... 3925
1007. Members ....................................................................................................................................... 3927
1008. Members ....................................................................................................................................... 3927
1009. Members ....................................................................................................................................... 3928
1010. Members ....................................................................................................................................... 3928
1011. Members ....................................................................................................................................... 3931
1012. Members ....................................................................................................................................... 3931
1013. Members ....................................................................................................................................... 3932
1014. Members ....................................................................................................................................... 3932
1015. Members ....................................................................................................................................... 3932
1016. Members ....................................................................................................................................... 3933
1017. Members ....................................................................................................................................... 3933
1018. Members ....................................................................................................................................... 3935

Release 2022 R2 - © 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 ....................................................................................................................................... 3950

1020. Members ....................................................................................................................................... 3950
1021. Members ....................................................................................................................................... 3950
1022. Members ....................................................................................................................................... 3951
1023. Members ....................................................................................................................................... 3951
1024. Members ....................................................................................................................................... 3951
1025. Members ....................................................................................................................................... 3952
1026. Members ....................................................................................................................................... 3952
1027. Members ....................................................................................................................................... 3952
1028. Members ....................................................................................................................................... 3953
1029. Members ....................................................................................................................................... 3953
1030. Members ....................................................................................................................................... 3953
1031. Members ....................................................................................................................................... 3953
1032. Members ....................................................................................................................................... 3954
1033. Members ....................................................................................................................................... 3954
1034. Members ....................................................................................................................................... 3954
1035. Members ....................................................................................................................................... 3955
1036. Members ....................................................................................................................................... 3955
1037. Members ....................................................................................................................................... 3955
1038. Members ....................................................................................................................................... 3956
1039. Members ....................................................................................................................................... 3956
1040. Members ....................................................................................................................................... 3956
1041. Members ....................................................................................................................................... 3957
1042. Members ....................................................................................................................................... 3957
1043. Members ....................................................................................................................................... 3957
1044. Members ....................................................................................................................................... 3958
1045. Members ....................................................................................................................................... 3958
1046. Members ....................................................................................................................................... 3958
1047. Members ....................................................................................................................................... 3959
1048. Members ....................................................................................................................................... 3959
1049. Members ....................................................................................................................................... 3959
1050. Members ....................................................................................................................................... 3960
1051. Members ....................................................................................................................................... 3960
1052. Members ....................................................................................................................................... 3960
1053. Members ....................................................................................................................................... 3961
1054. Members ....................................................................................................................................... 3961
1055. Members ....................................................................................................................................... 3961
1056. Members ....................................................................................................................................... 3962
1057. Members ....................................................................................................................................... 3962
1058. Members ....................................................................................................................................... 3962
1059. Members ....................................................................................................................................... 3963
1060. Members ....................................................................................................................................... 3963
1061. Members ....................................................................................................................................... 3963
1062. Members ....................................................................................................................................... 3964
1063. Members ....................................................................................................................................... 3964
1064. Members ....................................................................................................................................... 3964
1065. Members ....................................................................................................................................... 3965
1066. Members ....................................................................................................................................... 3965
1067. Members ....................................................................................................................................... 3965
1068. Members ....................................................................................................................................... 3966
1069. Members ....................................................................................................................................... 3966

Release 2022 R2 - © 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 ....................................................................................................................................... 3966

1071. Members ....................................................................................................................................... 3967
1072. Members ....................................................................................................................................... 3967
1073. Members ....................................................................................................................................... 3967
1074. Members ....................................................................................................................................... 3968
1075. Members ....................................................................................................................................... 3968
1076. Members ....................................................................................................................................... 3969
1077. Members ....................................................................................................................................... 3969
1078. Members ....................................................................................................................................... 3969
1079. Members ....................................................................................................................................... 3970
1080. Members ....................................................................................................................................... 3970
1081. Members ....................................................................................................................................... 3970
1082. Members ....................................................................................................................................... 3971
1083. Members ....................................................................................................................................... 3971
1084. Members ....................................................................................................................................... 3971
1085. Members ....................................................................................................................................... 3972
1086. Members ....................................................................................................................................... 3972
1087. Members ....................................................................................................................................... 3972
1088. Members ....................................................................................................................................... 3972
1089. Members ....................................................................................................................................... 3973
1090. Members ....................................................................................................................................... 3973
1091. Members ....................................................................................................................................... 3973
1092. Members ....................................................................................................................................... 3974
1093. Members ....................................................................................................................................... 3974
1094. Members ....................................................................................................................................... 3974
1095. Members ....................................................................................................................................... 3975
1096. Members ....................................................................................................................................... 3975
1097. Members ....................................................................................................................................... 3975
1098. Members ....................................................................................................................................... 3976
1099. Members ....................................................................................................................................... 3976
1100. Members ....................................................................................................................................... 3976
1101. Members ....................................................................................................................................... 3977
1102. Members ....................................................................................................................................... 3977
1103. Members ....................................................................................................................................... 3977
1104. Members ....................................................................................................................................... 3978
1105. Members ....................................................................................................................................... 3978
1106. Members ....................................................................................................................................... 3978
1107. Members ....................................................................................................................................... 3979
1108. Members ....................................................................................................................................... 3979
1109. Members ....................................................................................................................................... 3979
1110. Members ....................................................................................................................................... 3980
1111. Members ....................................................................................................................................... 3980
1112. Members ....................................................................................................................................... 3980
1113. Members ....................................................................................................................................... 3981
1114. Members ....................................................................................................................................... 3981
1115. Members ....................................................................................................................................... 3981
1116. Members ....................................................................................................................................... 3982
1117. Members ....................................................................................................................................... 3982
1118. Members ....................................................................................................................................... 3982
1119. Members ....................................................................................................................................... 3983
1120. Members ....................................................................................................................................... 3983

Release 2022 R2 - © 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 ....................................................................................................................................... 3983

1122. Members ....................................................................................................................................... 3984
1123. Members ....................................................................................................................................... 3984
1124. Members ....................................................................................................................................... 3984
1125. Members ....................................................................................................................................... 3985
1126. Members ....................................................................................................................................... 3985
1127. Members ....................................................................................................................................... 3985
1128. Members ....................................................................................................................................... 3986
1129. Members ....................................................................................................................................... 3986
1130. Members ....................................................................................................................................... 3986
1131. Members ....................................................................................................................................... 3987
1132. Members ....................................................................................................................................... 3987
1133. Members ....................................................................................................................................... 3987
1134. Members ....................................................................................................................................... 3988
1135. Members ....................................................................................................................................... 3988
1136. Members ....................................................................................................................................... 3988
1137. Members ....................................................................................................................................... 3989
1138. Members ....................................................................................................................................... 3989
1139. Members ....................................................................................................................................... 3989
1140. Members ....................................................................................................................................... 3990
1141. Members ....................................................................................................................................... 3990
1142. Members ....................................................................................................................................... 3990
1143. Members ....................................................................................................................................... 3991
1144. Members ....................................................................................................................................... 3991
1145. Members ....................................................................................................................................... 3992
1146. Members ....................................................................................................................................... 3992
1147. Members ....................................................................................................................................... 3992
1148. Members ....................................................................................................................................... 4011
1149. Members ....................................................................................................................................... 4011
1150. Members ....................................................................................................................................... 4011
1151. Members ....................................................................................................................................... 4012
1152. Members ....................................................................................................................................... 4012
1153. Members ....................................................................................................................................... 4012
1154. Members ....................................................................................................................................... 4013
1155. Members ....................................................................................................................................... 4013
1156. Members ....................................................................................................................................... 4013
1157. Members ....................................................................................................................................... 4014
1158. Members ....................................................................................................................................... 4014
1159. Members ....................................................................................................................................... 4014
1160. Members ....................................................................................................................................... 4015
1161. Members ....................................................................................................................................... 4015
1162. Members ....................................................................................................................................... 4015
1163. Members ....................................................................................................................................... 4016
1164. Members ....................................................................................................................................... 4016
1165. Members ....................................................................................................................................... 4016
1166. Members ....................................................................................................................................... 4017
1167. Members ....................................................................................................................................... 4017
1168. Members ....................................................................................................................................... 4018
1169. Members ....................................................................................................................................... 4018
1170. Members ....................................................................................................................................... 4018
1171. Members ....................................................................................................................................... 4018

Release 2022 R2 - © 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 ....................................................................................................................................... 4019

1173. Members ....................................................................................................................................... 4019
1174. Members ....................................................................................................................................... 4019
1175. Members ....................................................................................................................................... 4020
1176. Members ....................................................................................................................................... 4020
1177. Members ....................................................................................................................................... 4020
1178. Members ....................................................................................................................................... 4021
1179. Members ....................................................................................................................................... 4021
1180. Members ....................................................................................................................................... 4021
1181. Members ....................................................................................................................................... 4022
1182. Members ....................................................................................................................................... 4022
1183. Members ....................................................................................................................................... 4022
1184. Members ....................................................................................................................................... 4023
1185. Members ....................................................................................................................................... 4023
1186. Members ....................................................................................................................................... 4023
1187. Members ....................................................................................................................................... 4024
1188. Members ....................................................................................................................................... 4024
1189. Members ....................................................................................................................................... 4024
1190. Members ....................................................................................................................................... 4025
1191. Members ....................................................................................................................................... 4025
1192. Members ....................................................................................................................................... 4025
1193. Members ....................................................................................................................................... 4026
1194. Members ....................................................................................................................................... 4026
1195. Members ....................................................................................................................................... 4026
1196. Members ....................................................................................................................................... 4027
1197. Members ....................................................................................................................................... 4027
1198. Members ....................................................................................................................................... 4027
1199. Members ....................................................................................................................................... 4028
1200. Members ....................................................................................................................................... 4028
1201. Members ....................................................................................................................................... 4028
1202. Members ....................................................................................................................................... 4029
1203. Members ....................................................................................................................................... 4029
1204. Members ....................................................................................................................................... 4030
1205. Members ....................................................................................................................................... 4030
1206. Members ....................................................................................................................................... 4030
1207. Members ....................................................................................................................................... 4031
1208. Members ....................................................................................................................................... 4031
1209. Members ....................................................................................................................................... 4031
1210. Members ....................................................................................................................................... 4032
1211. Members ....................................................................................................................................... 4032
1212. Members ....................................................................................................................................... 4032
1213. Members ....................................................................................................................................... 4033
1214. Members ....................................................................................................................................... 4033
1215. Members ....................................................................................................................................... 4033
1216. Members ....................................................................................................................................... 4034
1217. Members ....................................................................................................................................... 4034
1218. Members ....................................................................................................................................... 4034
1219. Members ....................................................................................................................................... 4035
1220. Members ....................................................................................................................................... 4035
1221. Members ....................................................................................................................................... 4035
1222. Members ....................................................................................................................................... 4036

Release 2022 R2 - © 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 ....................................................................................................................................... 4036

1224. Members ....................................................................................................................................... 4036
1225. Members ....................................................................................................................................... 4037
1226. Members ....................................................................................................................................... 4037
1227. Members ....................................................................................................................................... 4038
1228. Members ....................................................................................................................................... 4038
1229. Members ....................................................................................................................................... 4038
1230. Members ....................................................................................................................................... 4039
1231. Members ....................................................................................................................................... 4039
1232. Members ....................................................................................................................................... 4039
1233. Members ....................................................................................................................................... 4040
1234. Members ....................................................................................................................................... 4040
1235. Members ....................................................................................................................................... 4040
1236. Members ....................................................................................................................................... 4041
1237. Members ....................................................................................................................................... 4041
1238. Members ....................................................................................................................................... 4041
1239. Members ....................................................................................................................................... 4042
1240. Members ....................................................................................................................................... 4042
1241. Members ....................................................................................................................................... 4042
1242. Members ....................................................................................................................................... 4043
1243. Members ....................................................................................................................................... 4043
1244. Members ....................................................................................................................................... 4043
1245. Members ....................................................................................................................................... 4044
1246. Members ....................................................................................................................................... 4044
1247. Members ....................................................................................................................................... 4044
1248. Members ....................................................................................................................................... 4044
1249. Members ....................................................................................................................................... 4045
1250. Members ....................................................................................................................................... 4045
1251. Members ....................................................................................................................................... 4045
1252. Members ....................................................................................................................................... 4046
1253. Members ....................................................................................................................................... 4046
1254. Members ....................................................................................................................................... 4046
1255. Members ....................................................................................................................................... 4047
1256. Members ....................................................................................................................................... 4047
1257. Members ....................................................................................................................................... 4048
1258. Members ....................................................................................................................................... 4048
1259. Members ....................................................................................................................................... 4048
1260. Members ....................................................................................................................................... 4048
1261. Members ....................................................................................................................................... 4049
1262. Members ....................................................................................................................................... 4049
1263. Members ....................................................................................................................................... 4050
1264. Members ....................................................................................................................................... 4050
1265. Members ....................................................................................................................................... 4051
1266. Members ....................................................................................................................................... 4051
1267. Members ....................................................................................................................................... 4051
1268. Members ....................................................................................................................................... 4052
1269. Members ....................................................................................................................................... 4052
1270. Members ....................................................................................................................................... 4052
1271. Members ....................................................................................................................................... 4053
1272. Members ....................................................................................................................................... 4053
1273. Members ....................................................................................................................................... 4053

Release 2022 R2 - © 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 ....................................................................................................................................... 4054

1275. Members ....................................................................................................................................... 4054
1276. Members ....................................................................................................................................... 4054
1277. Members ....................................................................................................................................... 4055
1278. Members ....................................................................................................................................... 4055
1279. Members ....................................................................................................................................... 4055
1280. Members ....................................................................................................................................... 4056
1281. Members ....................................................................................................................................... 4056
1282. Members ....................................................................................................................................... 4056
1283. Members ....................................................................................................................................... 4057
1284. Members ....................................................................................................................................... 4057
1285. Members ....................................................................................................................................... 4058
1286. Members ....................................................................................................................................... 4058
1287. Members ....................................................................................................................................... 4058
1288. Members ....................................................................................................................................... 4059
1289. Members ....................................................................................................................................... 4059
1290. Members ....................................................................................................................................... 4059
1291. Members ....................................................................................................................................... 4060
1292. Members ....................................................................................................................................... 4060
1293. Members ....................................................................................................................................... 4060
1294. Members ....................................................................................................................................... 4061
1295. Members ....................................................................................................................................... 4061
1296. Members ....................................................................................................................................... 4061
1297. Members ....................................................................................................................................... 4062
1298. Members ....................................................................................................................................... 4062
1299. Members ....................................................................................................................................... 4062
1300. Members ....................................................................................................................................... 4063
1301. Members ....................................................................................................................................... 4063
1302. Members ....................................................................................................................................... 4064
1303. Members ....................................................................................................................................... 4064
1304. Members ....................................................................................................................................... 4065
1305. Members ....................................................................................................................................... 4065
1306. Members ....................................................................................................................................... 4066
1307. Members ....................................................................................................................................... 4066
1308. Members ....................................................................................................................................... 4066
1309. Members ....................................................................................................................................... 4067
1310. Members ....................................................................................................................................... 4067
1311. Members ....................................................................................................................................... 4067
1312. Members ....................................................................................................................................... 4068
1313. Members ....................................................................................................................................... 4068
1314. Members ....................................................................................................................................... 4068
1315. Members ....................................................................................................................................... 4069
1316. Members ....................................................................................................................................... 4069
1317. Members ....................................................................................................................................... 4069
1318. Members ....................................................................................................................................... 4070
1319. Members ....................................................................................................................................... 4070
1320. Members ....................................................................................................................................... 4070
1321. Members ....................................................................................................................................... 4071
1322. Members ....................................................................................................................................... 4075
1323. Members ....................................................................................................................................... 4076
1324. Members ....................................................................................................................................... 4076

Release 2022 R2 - © 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 ....................................................................................................................................... 4077

1326. Members ....................................................................................................................................... 4077
1327. Members ....................................................................................................................................... 4077
1328. Members ....................................................................................................................................... 4078
1329. Members ....................................................................................................................................... 4078
1330. Members ....................................................................................................................................... 4079
1331. Members ....................................................................................................................................... 4079
1332. Members ....................................................................................................................................... 4079
1333. Members ....................................................................................................................................... 4080
1334. Members ....................................................................................................................................... 4080
1335. Members ....................................................................................................................................... 4080
1336. Members ....................................................................................................................................... 4081
1337. Members ....................................................................................................................................... 4081
1338. Members ....................................................................................................................................... 4082
1339. Members ....................................................................................................................................... 4083
1340. Members ....................................................................................................................................... 4083
1341. Members ....................................................................................................................................... 4084
1342. Members ....................................................................................................................................... 4084
1343. Members ....................................................................................................................................... 4084
1344. Members ....................................................................................................................................... 4085
1345. Members ....................................................................................................................................... 4086
1346. Members ....................................................................................................................................... 4086
1347. Members ....................................................................................................................................... 4087
1348. Members ....................................................................................................................................... 4087
1349. Members ....................................................................................................................................... 4088
1350. Members ....................................................................................................................................... 4088
1351. Members ....................................................................................................................................... 4088
1352. Members ....................................................................................................................................... 4089
1353. Members ....................................................................................................................................... 4089
1354. Members ....................................................................................................................................... 4089
1355. Members ....................................................................................................................................... 4090
1356. Members ....................................................................................................................................... 4090
1357. Members ....................................................................................................................................... 4091
1358. Members ....................................................................................................................................... 4091
1359. Members ....................................................................................................................................... 4091
1360. Members ....................................................................................................................................... 4092
1361. Members ....................................................................................................................................... 4092
1362. Members ....................................................................................................................................... 4093
1363. Members ....................................................................................................................................... 4093
1364. Members ....................................................................................................................................... 4093
1365. Members ....................................................................................................................................... 4094
1366. Members ....................................................................................................................................... 4094
1367. Members ....................................................................................................................................... 4094
1368. Members ....................................................................................................................................... 4095
1369. Members ....................................................................................................................................... 4095
1370. Members ....................................................................................................................................... 4095
1371. Members ....................................................................................................................................... 4096
1372. Members ....................................................................................................................................... 4096
1373. Members ....................................................................................................................................... 4096
1374. Members ....................................................................................................................................... 4096
1375. Members ....................................................................................................................................... 4097

Release 2022 R2 - © 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 ....................................................................................................................................... 4097

1377. Members ....................................................................................................................................... 4097
1378. Members ....................................................................................................................................... 4098
1379. Members ....................................................................................................................................... 4098
1380. Members ....................................................................................................................................... 4098
1381. Members ....................................................................................................................................... 4099
1382. Members ....................................................................................................................................... 4099
1383. Members ....................................................................................................................................... 4100
1384. Members ....................................................................................................................................... 4100
1385. Members ....................................................................................................................................... 4101
1386. Members ....................................................................................................................................... 4101
1387. Members ....................................................................................................................................... 4101
1388. Members ....................................................................................................................................... 4102
1389. Members ....................................................................................................................................... 4102
1390. Members ....................................................................................................................................... 4102
1391. Members ....................................................................................................................................... 4103
1392. Members ....................................................................................................................................... 4103
1393. Members ....................................................................................................................................... 4103
1394. Members ....................................................................................................................................... 4104
1395. Members ....................................................................................................................................... 4104
1396. Members ....................................................................................................................................... 4104
1397. Members ....................................................................................................................................... 4105
1398. Members ....................................................................................................................................... 4105
1399. Members ....................................................................................................................................... 4105
1400. Members ....................................................................................................................................... 4106
1401. Members ....................................................................................................................................... 4106
1402. Members ....................................................................................................................................... 4106
1403. Members ....................................................................................................................................... 4107
1404. Members ....................................................................................................................................... 4107
1405. Members ....................................................................................................................................... 4107
1406. Members ....................................................................................................................................... 4108
1407. Members ....................................................................................................................................... 4108
1408. Members ....................................................................................................................................... 4108
1409. Members ....................................................................................................................................... 4109
1410. Members ....................................................................................................................................... 4109
1411. Members ....................................................................................................................................... 4109
1412. Members ....................................................................................................................................... 4110
1413. Members ....................................................................................................................................... 4111
1414. Members ....................................................................................................................................... 4112
1415. Members ....................................................................................................................................... 4113
1416. Members ....................................................................................................................................... 4114
1417. Members ....................................................................................................................................... 4114
1418. Members ....................................................................................................................................... 4114
1419. Members ....................................................................................................................................... 4115
1420. Members ....................................................................................................................................... 4115
1421. Members ....................................................................................................................................... 4115
1422. Members ....................................................................................................................................... 4116
1423. Members ....................................................................................................................................... 4116
1424. Members ....................................................................................................................................... 4117
1425. Members ....................................................................................................................................... 4117
1426. Members ....................................................................................................................................... 4117

Release 2022 R2 - © 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 ....................................................................................................................................... 4118

1428. Members ....................................................................................................................................... 4118
1429. Members ....................................................................................................................................... 4118
1430. Members ....................................................................................................................................... 4119
1431. Members ....................................................................................................................................... 4119
1432. Members ....................................................................................................................................... 4119
1433. Members ....................................................................................................................................... 4120
1434. Members ....................................................................................................................................... 4120
1435. Members ....................................................................................................................................... 4121
1436. Members ....................................................................................................................................... 4121
1437. Members ....................................................................................................................................... 4121
1438. Members ....................................................................................................................................... 4122
1439. Members ....................................................................................................................................... 4122
1440. Members ....................................................................................................................................... 4122
1441. Members ....................................................................................................................................... 4123
1442. Members ....................................................................................................................................... 4123
1443. Members ....................................................................................................................................... 4123
1444. Members ....................................................................................................................................... 4124
1445. Members ....................................................................................................................................... 4124
1446. Members ....................................................................................................................................... 4124
1447. Members ....................................................................................................................................... 4125
1448. Members ....................................................................................................................................... 4125
1449. Members ....................................................................................................................................... 4125
1450. Members ....................................................................................................................................... 4126
1451. Members ....................................................................................................................................... 4126
1452. Members ....................................................................................................................................... 4126
1453. Members ....................................................................................................................................... 4135
1454. Members ....................................................................................................................................... 4135
1455. Members ....................................................................................................................................... 4135
1456. Members ....................................................................................................................................... 4135
1457. Members ....................................................................................................................................... 4136
1458. Members ....................................................................................................................................... 4136
1459. Members ....................................................................................................................................... 4136
1460. Members ....................................................................................................................................... 4137
1461. Members ....................................................................................................................................... 4137
1462. Members ....................................................................................................................................... 4137
1463. Members ....................................................................................................................................... 4138
1464. Members ....................................................................................................................................... 4138
1465. Members ....................................................................................................................................... 4138
1466. Members ....................................................................................................................................... 4139
1467. Members ....................................................................................................................................... 4139
1468. Members ....................................................................................................................................... 4143
1469. Members ....................................................................................................................................... 4143
1470. Members ....................................................................................................................................... 4144
1471. Members ....................................................................................................................................... 4144
1472. Members ....................................................................................................................................... 4145
1473. Members ....................................................................................................................................... 4145
1474. Members ....................................................................................................................................... 4146
1475. Members ....................................................................................................................................... 4146
1476. Members ....................................................................................................................................... 4146
1477. Members ....................................................................................................................................... 4147

Release 2022 R2 - © 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 ....................................................................................................................................... 4147

1479. Members ....................................................................................................................................... 4147
1480. Members ....................................................................................................................................... 4148
1481. Members ....................................................................................................................................... 4148
1482. Members ....................................................................................................................................... 4148
1483. Members ....................................................................................................................................... 4149
1484. Members ....................................................................................................................................... 4149
1485. Members ....................................................................................................................................... 4149
1486. Members ....................................................................................................................................... 4150
1487. Members ....................................................................................................................................... 4150
1488. Members ....................................................................................................................................... 4150
1489. Members ....................................................................................................................................... 4151
1490. Members ....................................................................................................................................... 4151
1491. Members ....................................................................................................................................... 4151
1492. Members ....................................................................................................................................... 4153
1493. Members ....................................................................................................................................... 4153
1494. Members ....................................................................................................................................... 4153
1495. Members ....................................................................................................................................... 4154
1496. Members ....................................................................................................................................... 4154
1497. Members ....................................................................................................................................... 4154
1498. Members ....................................................................................................................................... 4155
1499. Members ....................................................................................................................................... 4155
1500. Members ....................................................................................................................................... 4155
1501. Members ....................................................................................................................................... 4156
1502. Members ....................................................................................................................................... 4156
1503. Members ....................................................................................................................................... 4156
1504. Members ....................................................................................................................................... 4156
1505. Members ....................................................................................................................................... 4157
1506. Members ....................................................................................................................................... 4157
1507. Members ....................................................................................................................................... 4157
1508. Members ....................................................................................................................................... 4158
1509. Members ....................................................................................................................................... 4158
1510. Members ....................................................................................................................................... 4158
1511. Members ....................................................................................................................................... 4159
1512. Members ....................................................................................................................................... 4159
1513. Members ....................................................................................................................................... 4159
1514. Members ....................................................................................................................................... 4160
1515. Members ....................................................................................................................................... 4160
1516. Members ....................................................................................................................................... 4160
1517. Members ....................................................................................................................................... 4160
1518. Members ....................................................................................................................................... 4161
1519. Members ....................................................................................................................................... 4161
1520. Members ....................................................................................................................................... 4162
1521. Members ....................................................................................................................................... 4162
1522. Members ....................................................................................................................................... 4162
1523. Members ....................................................................................................................................... 4163
1524. Members ....................................................................................................................................... 4163
1525. Members ....................................................................................................................................... 4163
1526. Members ....................................................................................................................................... 4164
1527. Members ....................................................................................................................................... 4164
1528. Members ....................................................................................................................................... 4164

Release 2022 R2 - © 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 ....................................................................................................................................... 4165

1530. Members ....................................................................................................................................... 4165
1531. Members ....................................................................................................................................... 4165
1532. Members ....................................................................................................................................... 4166
1533. Members ....................................................................................................................................... 4166
1534. Members ....................................................................................................................................... 4166
1535. Members ....................................................................................................................................... 4167
1536. Members ....................................................................................................................................... 4167
1537. Members ....................................................................................................................................... 4167
1538. Members ....................................................................................................................................... 4168
1539. Members ....................................................................................................................................... 4168
1540. Members ....................................................................................................................................... 4168
1541. Members ....................................................................................................................................... 4169
1542. Members ....................................................................................................................................... 4169
1543. Members ....................................................................................................................................... 4169
1544. Members ....................................................................................................................................... 4169
1545. Members ....................................................................................................................................... 4170
1546. Members ....................................................................................................................................... 4170
1547. Members ....................................................................................................................................... 4170
1548. Members ....................................................................................................................................... 4171
1549. Members ....................................................................................................................................... 4171
1550. Members ....................................................................................................................................... 4171
1551. Members ....................................................................................................................................... 4172
1552. Members ....................................................................................................................................... 4172
1553. Members ....................................................................................................................................... 4172
1554. Members ....................................................................................................................................... 4173
1555. Members ....................................................................................................................................... 4173
1556. Members ....................................................................................................................................... 4173
1557. Members ....................................................................................................................................... 4174
1558. Members ....................................................................................................................................... 4174
1559. Members ....................................................................................................................................... 4174
1560. Members ....................................................................................................................................... 4175
1561. Members ....................................................................................................................................... 4175
1562. Members ....................................................................................................................................... 4175
1563. Members ....................................................................................................................................... 4176
1564. Members ....................................................................................................................................... 4179
1565. Members ....................................................................................................................................... 4179
1566. Members ....................................................................................................................................... 4180
1567. Members ....................................................................................................................................... 4180
1568. Members ....................................................................................................................................... 4181
1569. Members ....................................................................................................................................... 4181
1570. Members ....................................................................................................................................... 4181
1571. Members ....................................................................................................................................... 4182
1572. Members ....................................................................................................................................... 4182
1573. Members ....................................................................................................................................... 4183
1574. Members ....................................................................................................................................... 4183
1575. Members ....................................................................................................................................... 4183
1576. Members ....................................................................................................................................... 4184
1577. Members ....................................................................................................................................... 4184
1578. Members ....................................................................................................................................... 4184
1579. Members ....................................................................................................................................... 4185

Release 2022 R2 - © 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 ....................................................................................................................................... 4185

1581. Members ....................................................................................................................................... 4186
1582. Members ....................................................................................................................................... 4186
1583. Members ....................................................................................................................................... 4187
1584. Members ....................................................................................................................................... 4187
1585. Members ....................................................................................................................................... 4189
1586. Members ....................................................................................................................................... 4189
1587. Members ....................................................................................................................................... 4190
1588. Members ....................................................................................................................................... 4190
1589. Members ....................................................................................................................................... 4190
1590. Members ....................................................................................................................................... 4191
1591. Members ....................................................................................................................................... 4191
1592. Members ....................................................................................................................................... 4192
1593. Members ....................................................................................................................................... 4192
1594. Members ....................................................................................................................................... 4193
1595. Members ....................................................................................................................................... 4193
1596. Members ....................................................................................................................................... 4195
1597. Members ....................................................................................................................................... 4197
1598. Members ....................................................................................................................................... 4197
1599. Members ....................................................................................................................................... 4206
1600. Members ....................................................................................................................................... 4219
1601. Members ....................................................................................................................................... 4219
1602. Members ....................................................................................................................................... 4221
1603. Members ....................................................................................................................................... 4222
1604. Members ....................................................................................................................................... 4223
1605. Members ....................................................................................................................................... 4224
1606. Members ....................................................................................................................................... 4226
1607. Members ....................................................................................................................................... 4226
1608. Members ....................................................................................................................................... 4227
1609. Members ....................................................................................................................................... 4229
1610. Members ....................................................................................................................................... 4229
1611. Members ....................................................................................................................................... 4230
1612. Members ....................................................................................................................................... 4231
1613. Members ....................................................................................................................................... 4235
1614. Members ....................................................................................................................................... 4235
1615. Members ....................................................................................................................................... 4237
1616. Members ....................................................................................................................................... 4242
1617. Members ....................................................................................................................................... 4243
1618. Members ....................................................................................................................................... 4244
1619. Members ....................................................................................................................................... 4246
1620. Members ....................................................................................................................................... 4249
1621. Members ....................................................................................................................................... 4250
1622. Members ....................................................................................................................................... 4251
1623. Members ....................................................................................................................................... 4251
1624. Members ....................................................................................................................................... 4252
1625. Members ....................................................................................................................................... 4252
1626. Members ....................................................................................................................................... 4252
1627. Members ....................................................................................................................................... 4255
1628. Members ....................................................................................................................................... 4256
1629. Members ....................................................................................................................................... 4256
1630. Members ....................................................................................................................................... 4257

Release 2022 R2 - © 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 ....................................................................................................................................... 4259

1632. Members ....................................................................................................................................... 4261
1633. Members ....................................................................................................................................... 4261
1634. Members ....................................................................................................................................... 4262
1635. Members ....................................................................................................................................... 4266
1636. Members ....................................................................................................................................... 4268
1637. Members ....................................................................................................................................... 4268
1638. Members ....................................................................................................................................... 4270
1639. Members ....................................................................................................................................... 4273
1640. Members ....................................................................................................................................... 4274
1641. Members ....................................................................................................................................... 4276
1642. Members ....................................................................................................................................... 4278
1643. Members ....................................................................................................................................... 4284
1644. Members ....................................................................................................................................... 4287
1645. Members ....................................................................................................................................... 4288
1646. Members ....................................................................................................................................... 4289
1647. Members ....................................................................................................................................... 4289
1648. Members ....................................................................................................................................... 4292
1649. Members ....................................................................................................................................... 4293
1650. Members ....................................................................................................................................... 4295
1651. Members ....................................................................................................................................... 4297
1652. Members ....................................................................................................................................... 4299
1653. Members ....................................................................................................................................... 4299
1654. Members ....................................................................................................................................... 4301
1655. Members ....................................................................................................................................... 4303
1656. Members ....................................................................................................................................... 4303
1657. Members ....................................................................................................................................... 4305
1658. Members ....................................................................................................................................... 4305
1659. Members ....................................................................................................................................... 4306
1660. Members ....................................................................................................................................... 4309
1661. Members ....................................................................................................................................... 4312
1662. Members ....................................................................................................................................... 4317
1663. Members ....................................................................................................................................... 4320
1664. Members ....................................................................................................................................... 4321
1665. Members ....................................................................................................................................... 4322
1666. Members ....................................................................................................................................... 4322
1667. Members ....................................................................................................................................... 4322
1668. Members ....................................................................................................................................... 4323
1669. Members ....................................................................................................................................... 4323
1670. Members ....................................................................................................................................... 4325
1671. Members ....................................................................................................................................... 4325
1672. Members ....................................................................................................................................... 4326
1673. Members ....................................................................................................................................... 4328
1674. Members ....................................................................................................................................... 4329
1675. Members ....................................................................................................................................... 4333
1676. Members ....................................................................................................................................... 4334
1677. Members ....................................................................................................................................... 4337
1678. Members ....................................................................................................................................... 4337
1679. Members ....................................................................................................................................... 4338
1680. Members ....................................................................................................................................... 4339
1681. Members ....................................................................................................................................... 4340

Release 2022 R2 - © 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 ....................................................................................................................................... 4343

1683. Members ....................................................................................................................................... 4348
1684. Members ....................................................................................................................................... 4349
1685. Members ....................................................................................................................................... 4350
1686. Members ....................................................................................................................................... 4361
1687. Members ....................................................................................................................................... 4365
1688. Members ....................................................................................................................................... 4366
1689. Members ....................................................................................................................................... 4368
1690. Members ....................................................................................................................................... 4369
1691. Members ....................................................................................................................................... 4369
1692. Members ....................................................................................................................................... 4370
1693. Members ....................................................................................................................................... 4374
1694. Members ....................................................................................................................................... 4377
1695. Members ....................................................................................................................................... 4379
1696. Members ....................................................................................................................................... 4379
1697. Members ....................................................................................................................................... 4381
1698. Members ....................................................................................................................................... 4382
1699. Members ....................................................................................................................................... 4382
1700. Members ....................................................................................................................................... 4384
1701. Members ....................................................................................................................................... 4384
1702. Members ....................................................................................................................................... 4386
1703. Members ....................................................................................................................................... 4388
1704. Members ....................................................................................................................................... 4388
1705. Members ....................................................................................................................................... 4389
1706. Members ....................................................................................................................................... 4390
1707. Members ....................................................................................................................................... 4391
1708. Members ....................................................................................................................................... 4394
1709. Members ....................................................................................................................................... 4394
1710. Members ....................................................................................................................................... 4395
1711. Members ....................................................................................................................................... 4397
1712. Members ....................................................................................................................................... 4398
1713. Members ....................................................................................................................................... 4398
1714. Members ....................................................................................................................................... 4398
1715. Members ....................................................................................................................................... 4399
1716. Members ....................................................................................................................................... 4400
1717. Members ....................................................................................................................................... 4402
1718. Members ....................................................................................................................................... 4403
1719. Members ....................................................................................................................................... 4404
1720. Members ....................................................................................................................................... 4408
1721. Members ....................................................................................................................................... 4408
1722. Members ....................................................................................................................................... 4410
1723. Members ....................................................................................................................................... 4411
1724. Members ....................................................................................................................................... 4413
1725. Members ....................................................................................................................................... 4414
1726. Members ....................................................................................................................................... 4416
1727. Members ....................................................................................................................................... 4417
1728. Members ....................................................................................................................................... 4417
1729. Members ....................................................................................................................................... 4418
1730. Members ....................................................................................................................................... 4419
1731. Members ....................................................................................................................................... 4420
1732. Members ....................................................................................................................................... 4421

Release 2022 R2 - © 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 ....................................................................................................................................... 4421

1734. Members ....................................................................................................................................... 4423
1735. Members ....................................................................................................................................... 4424
1736. Members ....................................................................................................................................... 4424
1737. Members ....................................................................................................................................... 4424
1738. Members ....................................................................................................................................... 4427
1739. Members ....................................................................................................................................... 4428
1740. Members ....................................................................................................................................... 4429
1741. Members ....................................................................................................................................... 4430
1742. Members ....................................................................................................................................... 4431
1743. Members ....................................................................................................................................... 4432
1744. Members ....................................................................................................................................... 4433
1745. Members ....................................................................................................................................... 4434
1746. Members ....................................................................................................................................... 4436
1747. Members ....................................................................................................................................... 4437
1748. Members ....................................................................................................................................... 4438
1749. Members ....................................................................................................................................... 4439
1750. Members ....................................................................................................................................... 4440
1751. Members ....................................................................................................................................... 4440
1752. Members ....................................................................................................................................... 4440
1753. Members ....................................................................................................................................... 4441
1754. Members ....................................................................................................................................... 4443
1755. Members ....................................................................................................................................... 4443
1756. Members ....................................................................................................................................... 4444
1757. Members ....................................................................................................................................... 4454
1758. Members ....................................................................................................................................... 4456
1759. Members ....................................................................................................................................... 4457
1760. Members ....................................................................................................................................... 4459
1761. Members ....................................................................................................................................... 4460
1762. Members ....................................................................................................................................... 4463
1763. Members ....................................................................................................................................... 4467
1764. Members ....................................................................................................................................... 4467
1765. Members ....................................................................................................................................... 4469
1766. Members ....................................................................................................................................... 4471
1767. Members ....................................................................................................................................... 4473
1768. Members ....................................................................................................................................... 4477
1769. Members ....................................................................................................................................... 4477
1770. Members ....................................................................................................................................... 4485
1771. Members ....................................................................................................................................... 4487
1772. Members ....................................................................................................................................... 4491
1773. Members ....................................................................................................................................... 4501
1774. Members ....................................................................................................................................... 4501
1775. Members ....................................................................................................................................... 4505
1776. Members ....................................................................................................................................... 4506
1777. Members ....................................................................................................................................... 4510
1778. Members ....................................................................................................................................... 4512
1779. Members ....................................................................................................................................... 4517
1780. Members ....................................................................................................................................... 4517
1781. Members ....................................................................................................................................... 4518
1782. Members ....................................................................................................................................... 4518
1783. Members ....................................................................................................................................... 4519

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ccxciii
ACT API Reference Guide

1784. Members ....................................................................................................................................... 4520

1785. Members ....................................................................................................................................... 4521
1786. Members ....................................................................................................................................... 4525
1787. Members ....................................................................................................................................... 4531
1788. Members ....................................................................................................................................... 4531
1789. Members ....................................................................................................................................... 4538
1790. Members ....................................................................................................................................... 4540
1791. Members ....................................................................................................................................... 4542
1792. Members ....................................................................................................................................... 4543
1793. Members ....................................................................................................................................... 4543
1794. Members ....................................................................................................................................... 4549
1795. Members ....................................................................................................................................... 4549
1796. Members ....................................................................................................................................... 4550
1797. Members ....................................................................................................................................... 4551
1798. Members ....................................................................................................................................... 4559
1799. Members ....................................................................................................................................... 4564
1800. Members ....................................................................................................................................... 4570

Release 2022 R2 - © 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 2022 R2 - © 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 2022 R2 - © 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
 Release 2022 R2 - © 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)
Method Clone() (p. 8)
Method Contains(string) (p. 8)
Method GetStringValue(string) (p. 8)
Method GetValue(string) (p. 8)
Method GetValue(string, object) (p. 9)
Method Remove(string) (p. 9)
Method SetValue(string, object) (p. 9)
The list of the available keys in the collection.
Create a clone of the currection collection.
Check if the collection contains an attribute.
Gets an attribute value by its name.
Gets an attribute value by its name.
Gets an attribute value by its name.
Remove an attribute. The attribute cannot be removed if
it was declared as static attribute.
Set an attribute value.

Item(string)
Get or set an attribute value.

Declaration Syntax
public object Item { set;get; }

Release 2022 R2 - © 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 2022 R2 - © 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 2022 R2 - © 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.DesignModeler.Primitives.Sheet
Namespace
Declaration Syntax
namespace Ansys.ACT.DesignModeler.Primitives.Sheet

Table 9: Members

Cylinder (p. 11) Cylinder

Class

Cylinder
Cylinder Class

Declaration Syntax
public class Cylinder : Primitive, ISheetCylinder

Table 10: Members

Constructor Cylinder(GeometryBuilder, Create a new Cylinder.

IEnumerable<double>,
IEnumerable<double>, double) (p. 11)
Property Center (p. 12) Gets or sets the center of the cylinder.
Property Direction (p. 12) Gets or sets the axis of the cylinder.
Property Radius (p. 12) Gets or sets the radius of the cylinder.
Method Generate() (p. 12) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical

Table 11: Members

Transaction (p. 13) Speeds up bulk user interactions.

UnitsHelper (p. 13) 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 12: Members

Method ConvertMechanicalUnitToCoreUnit(string, Takes input mechanical unit string and category

string) (p. 13) string And returns framework unit string which
can be used for conversion
Method GetValidQuantityNamesAndUnits() (p. 14) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Fields Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Fields

Table 13: Members

Field (p. 15) Represents a discrete or continuous field that can be used in a
component of a boundary condition from Mechanical, for instance.
Range (p. 16) Represents a domain for real values.
Variable (p. 17) 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. 20) 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 14: Members

Property Inputs (p. 15) Gets the input variables of this

component.
Property Name (p. 16) Gets the name of this component.
Property Output (p. 16) Gets the output variable of this
component.

Inputs
Gets the input variables of this component.

Declaration Syntax
public IList<Variable> Inputs { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
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 15: Members

Field Maximum (p. 16) No details are provided for this

entry.
Field Minimum (p. 16) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
16 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 16: Members

Property DefinitionType (p. 17)
Property DiscreteValueCount (p. 18)
Property DiscreteValues (p. 18)
Gets a value that indicates how this variable is defined.
Gets the number of discrete values of this variable.
Gets or sets the discrete values of this variable or if this
variable represents a free degree of freedom.
null

Property Field (p. 18) Gets the owner field.

Property Formula (p. 18) 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. 18) Gets the index of this variable in its container field.
Property IsInput (p. 19) Gets a value indicating whether this variable is an input for
its container field. Otherwise, it is an output variable.
Property IsOutput (p. 19) Gets a value indicating whether this variable is an output for
its container field. Otherwise, it is an input variable.
Property MinMaxDiscreteValues (p. 19) Returns a Tuple containing the min and max values from the
list of discrete values.
Property Name (p. 19) Gets the variable's name.
Property QuantityName (p. 19) Gets the name of the quantity represented by this variable.
Property Range (p. 19) Gets the domain of validity for variable's value.
Property Unit (p. 20) Gets the symbol of the unit used to express this variable's
values.
Method GetDiscreteValue(int) (p. 20) 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. 20) of the variable.

DefinitionType
Gets a value that indicates how this variable is defined.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
18 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
 VariableDefinitionType

Declaration Syntax
public enum VariableDefinitionType

Table 17: 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Fields.Adapters Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Fields.Adapters

Table 18: Members

FieldAdapter (p. 23)
FieldAdapterManager (p. 26)
Base class for objects that handle the interface between the generic
boundary condition wrapper and the various types of concrete object
implemented in Mechanical.
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 19: Members

Constructor FieldAdapter(IDSBCInformation) (p. 23) No details are provided for this entry.
Property FieldProvider (p. 24) Gets the wrapped object from Mechanical.
Method ChangeFieldDefinitionType(AnsBCLVType, Changes the definition type for a field of the
kEDDataType) (p. 24) wrapped object from Mechanical.
NestedType IDefinition (p. 24) Interface implemented by objects that specify
a type of adapter for a given field provider
object from Mechanical.
NestedType Keywords (p. 25) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
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 20: Members

Method Adapt(IDSBCInformation) (p. 25) Creates an adapter for a given load object from
Mechanical.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
24 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 21: Members

Field Constant (p. 25) No details are provided for this

entry.
Field ConstantRamped (p. 25) No details are provided for this
entry.
Field Free (p. 26) No details are provided for this
entry.
Field Function (p. 26) No details are provided for this
entry.
Field Table (p. 26) No details are provided for this
entry.
Method Get(kEDDataType) (p. 26) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
 FieldAdapterManager

Declaration Syntax
public static class FieldAdapterManager

Table 22: Members

Property AdapterDefinitions (p. 27) Gets the collection of adapters in this manager.
Method RegisterNewAdapter(IDefinition) (p. 27) Register the instance object that defines a type of
field adapter.
Method UnregisterAdapter(int) (p. 27) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Utilities Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Utilities

Table 23: Members

GeometryImportPreferences (p. 29) 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 24: Members

Property AnalysisType (p. 31) Specify the analysis type to target during import.
Property AttributeKey (p. 31) 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. 31) Allow associativity.
Property Clean (p. 31) Clean unwanted features when importing geometry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
Ansys.ACT.Mechanical.Utilities Namespace

Property ComparePartsOnUpdate (p. 31) Enable mesh preservation on refresh for unmodified
entities.
Property ComparePartsTolerance (p. 31) Specifies the tolerance to use when comparing parts.
Property CoordinateSystemKey (p. 32) 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. 32) Enable the decomposition of disjoint geometries for
the following associative geometry interfaces:

Creo Parametric (faces only)

Property DoSmartUpdate (p. 32)
Property EnclosureSymmetryProcessing (p. 32) Enable the processing of enclosure and symmetry
named selections.
Property FacetQuality (p. 32)
Property MixedImportResolution (p. 33)
Property NamedSelectionKey (p. 33)
Property ProcessAttributes (p. 33)
Property ProcessCoordinateSystems (p. 33)
Property ProcessInstances (p. 33)
Property ProcessLines (p. 33)
Property ProcessMaterialProperties (p. 34)
Property ProcessNamedSelections (p. 34)
Property ProcessSolids (p. 34)
Property ProcessSurfaces (p. 34)
Property ProcessWorkPoints (p. 34)
Property ReaderSaveFile (p. 34)
Property StitchTolerance (p. 35)
Property StitchType (p. 35)
Autodesk Inventor (bodies only)
Speed up refreshes for models with unmodified
components. Causes changes to other import
preferences to be ignored during refresh.
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.
Allows mixed-dimension parts to be imported as
assembly components with parts of different
dimensions.
If `ProcessNamedSelections` is `true`, import only
those named selections with this prefix. Multiple
semicolon-delimited filters may be specified.
Import CAD system attributes.
Import coordinate systems defined in the CAD source.
Honor part instance specifications.
Import lines bodies.
Import primary material data defined in the CAD
source.
Import/create named selections.
Import solid bodies.
Import surface bodies.
Import work points.
Save the part file of a model after the import.
If `StitchType` is `User`, specifies the tolerance to use
for stitching detection.
Specifies how surfaces should be stitched together.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
30 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
32 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.Application.SolveProcessSettings
Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.Application.SolveProcessSettings

Table 25: Members

ILinuxSettings (p. 37) No details are provided for this entry.

IQueueSettings (p. 38)
ISolveConfiguration (p. 40)
ISolveProcessSettings (p. 41)
ISolverMemorySettings (p. 44)
LinuxSettings (p. 45)
QueueSettings (p. 46)
RSMQueue (p. 47)
SolveConfiguration (p. 48)
SolveProcessSettings (p. 50)
SolverMemorySettings (p. 53)
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
No details are provided for this entry.
The class representing the linux settings portion of the solve process
settings.
The class representing queue settings.
The class representing an RSM Queue.
The class representing a solve configuration.
The class representing solve process settings.
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 26: Members

Property Active (p. 38) Gets or sets whether or not manual linux settings are enable for
the configuration.
Property UserName (p. 38) Gets or sets the user name field for the manual linux settings.
Property WorkingFolder (p. 38) Gets or sets the working folder field for the manual linxus settings.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
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 27: Members

Property DCSPassword (p. 38) No details are provided for this entry.
Property DCSUrl (p. 39) No details are provided for this entry.
Property DCSUsername (p. 39) No details are provided for this entry.
Property JobName (p. 39) Gets or sets the Job Name field for the queue settings.
Property License (p. 39) Gets or sets the License field for the queue settings.
Property Name (p. 39) Gets or sets the name of the current queue for the
configuration.
Property SolutionExecutionTarget (p. 39) No details are provided for this entry.

DCSPassword
No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
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 28: Members

Property Default (p. 40) Gets whether or not this SolveConfiguration is the default
configuration.
Property Name (p. 40) Gets or sets the name of the SolveConfiguraiton Object
Property Settings (p. 40) Gets the QueueSettings object for the configuration.
Property SolveProcessSettings (p. 41) Gets the SolveProcessSettings for the current object.
Method SetAsDefault() (p. 41) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 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 29: Members

Property AdditionalCommandLineArguments (p. 42) Gets or sets the "Additional Command Line
Arguments" field.
Property CustomExecutablePath (p. 42) Gets or sets the "Custom Executable Name
(with path)" field.
Property DistributeSolution (p. 42) Gets or sets the boolean "Distribute Solution
(if possible)" field.
Property GPUAccelerationDevice (p. 42) Gets or sets the "GPU Acceleration Device" field.
Property HybridParallel (p. 42) Gets or sets the boolean "Hybrid Parallel
(Mechanical APDL)" field.
Property LicenseQueuing (p. 43) Gets or sets the "License Queuing: Wait for
Available License" field.
Property ManualLinuxSettings (p. 43) Gets the LinuxSettings object for the
configuration.
Property ManualSolverMemorySettings (p. 43) Gets the SolverMemorySettings object for the
configuration.
Property MaxNumberOfCores (p. 43) Gets or sets the "Maximum number of utilized
cores" field.
Property NumberOfGPUDevices (p. 43) Gets or sets the "Number of utilized GPU
devices" field.
Property NumberOfProcesses (p. 43) Gets or sets the "Number of processes" field.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

Property SolveInSynchronousMode (p. 44) Gets or sets the "Solve in synchronous mode"
field.
Property ThreadsPerProcess (p. 44) Gets or sets the "Threads per process" field.
Property UserString (p. 44) Gets or sets the User String field.
Property UseSharedLicense (p. 44) 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; }

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
 ISolveProcessSettings

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.

Declaration Syntax
public int NumberOfGPUDevices { set;get; }

NumberOfProcesses
Gets or sets the "Number of processes" field.

Declaration Syntax
public int NumberOfProcesses { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

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.

Declaration Syntax
public interface ISolverMemorySettings

Table 30: Members

Property Active (p. 45) Gets or sets whether or not manual memory settings are active in the
current configuration.
Property Database (p. 45) Gets or sets the database memory amount (MB).
Property Workspace (p. 45) Gets or sets the workspace memory amount (megabytes).

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
 LinuxSettings

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 31: Members

Constructor LinuxSettings() (p. 45) Creates a LinuxSettings object

Property Active (p. 46) Whether the linux settings are
active.
Property UserName (p. 46) The user name.
Property WorkingFolder (p. 46) The working folder.

LinuxSettings()
Creates a LinuxSettings object

Declaration Syntax
public LinuxSettings()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

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 32: Members

Constructor QueueSettings() (p. 46) Creates a QueueSettings object

Property JobName (p. 47) The job name of the queue settings.
Property License (p. 47) The license of the queue settings. The setter will throw an
exception if the given license is not valid.
Property Name (p. 47) The name of the queue settings.

QueueSettings()
Creates a QueueSettings object

Declaration Syntax
public QueueSettings()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
 RSMQueue

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.

Declaration Syntax
public class RSMQueue

Table 33: Members

Property HPCConfiguration (p. 47) The HPC configuration of the RSM

Queue.
Property HPCQueue (p. 48) The HPC Queue of the RSM Queue.
Property HPCType (p. 48) The HPC type of the RSM Queue
Property Name (p. 48) The name of the RSM Queue.

HPCConfiguration
The HPC configuration of the RSM Queue.

Declaration Syntax
public string HPCConfiguration { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

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.

Declaration Syntax
public class SolveConfiguration : ISolveConfiguration, IEquatable<SolveConfiguration>

Table 34: Members

Constructor SolveConfiguration() (p. 49) Creates a SolveConfiguration object

Constructor SolveConfiguration(string) (p. 49) Creates a SolveConfiguration object with a given name
or gets the instance of an existing SolveConfiguration
with that name.
Property Default (p. 49) Whether this solve configuration is the default.
Property Name (p. 49) The name of the solve configuration.
Property Settings (p. 49) Returns the queue settings of this solve configuration.
Property SolveProcessSettings (p. 50) Returns the solve process settings of this solve
configuration.
Method SetAsDefault() (p. 50) Sets this solve configuration as the default.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolveConfiguration

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

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 35: Members

Constructor SolveProcessSettings() (p. 51) Creates a SolveProcessSettings object

Property AdditionalCommandLineArguments (p. 51) Any additional command line arguments to
give to the solver.
Property CustomExecutablePath (p. 51) The custom executable path for user
programmable features in the solver.
Property DistributeSolution (p. 51) Whether to run the solution in distributed
mode.
Property GPUAccelerationDevice (p. 51) The GPU Acceleration device the solver will
use.
Property HybridParallel (p. 51) Whether to run the solution in hybrid
parallel.
Property LicenseQueuing (p. 52) Whether license queueing is active.
Property ManualLinuxSettings (p. 52) Returns the manual linux settings.
Property ManualSolverMemorySettings (p. 52) Returns the manual solver memory settings.
Property MaxNumberOfCores (p. 52) The maximum number of cores the solver
will use.
Property NumberOfGPUDevices (p. 52) The number of GPU devices.
Property NumberOfProcesses (p. 52) The number of processes the solver will use.
Property SolveInSynchronousMode (p. 53) Whether the solve will be in synchronous
mode.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolveProcessSettings

Property ThreadsPerProcess (p. 53) The threads per process the solver will use.
Property UseSharedLicense (p. 53) 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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolverMemorySettings

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; }

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 36: Members

Constructor SolverMemorySettings() (p. 53) Creates a SolverMemorySettings object

Property Active (p. 54) Whether the solver memory settings are
active.
Property Database (p. 54) Database size.
Property Workspace (p. 54) Workspace size.

SolverMemorySettings()
Creates a SolverMemorySettings object

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace

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; }

Workspace
Workspace size.

Declaration Syntax
public int Workspace { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Mechanical.AdditionalProperties
Namespace
Declaration Syntax
namespace Ansys.ACT.Mechanical.AdditionalProperties

Table 37: Members

ApplyCancelProperty (p. 55)
Control (p. 55)
DoubleProperty (p. 56)
ExpressionProperty (p. 56)
OptionsProperty (p. 56)
Provides a way to create properties with Apply/Cancel buttons.
The control type for an additional property.
Provides a way to create properties that can hold double type values.
Provides a way to create properties that can hold expressions.
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 38: Members

Field OnApply (p. 55) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
Ansys.ACT.Mechanical.AdditionalProperties Namespace

Declaration Syntax
public enum Control

Table 39: 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 40: Members

Property ValidRange (p. 56) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
 OptionsProperty

Declaration Syntax
public class OptionsProperty : CustomProperty

Table 41: Members

Field GetOptionsCallback (p. 57) Use this callback to dynamically add options to the options
dictionary.
Property Options (p. 57) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.DesignModeler

Table 42: Members

IDesignModelerDataModel (p. 60) Defines the DesignModeler data model.

IDesignModelerExtAPI (p. 61) Defines the main entry point of all APIs.
IDesignModelerGeoData (p. 62) Defines the DesignModeler geometry data model.
IDesignModelerGeoFeature (p. 62) Defines a DesignModeler custom feature.
IDesignModelerSelectionInfo (p. 63) Defines the DesignModeler selection information.
IExtrude (p. 64) Defines an "Extrude" operation.
IGeometryBuilder (p. 65) Defines the geometry builder.
IIntersect (p. 66) Defines an "Intersect" operation.
IOperations (p. 66) Defines a list of available geometry operations.
IOperationTools (p. 69) Defines a list of tools to manipulate the geometry.
IPrimitives (p. 74) Defines the list of creatable primitives.
IPSGeoBody (p. 74) Defines a body.
IPSGeoEdge (p. 75) Defines an edge.
IPSGeoEntity (p. 75) Defines a generic geometry entity.
IPSGeoFace (p. 75) Defines a face.
IPSGeoPart (p. 75) Defines a part.
IQueries (p. 75) Defines a list of available queries on the geometry.
IRevolve (p. 77) Defines a "Revolve" operation.
ISheetCone (p. 79) Defines a sheet cone primitive.
ISheetCylinder (p. 80) Defines a sheet cylinder primitive.
ISheetPolygon (p. 81) Defines a sheet polygon primitive.
ISheets (p. 81) Defines the list all creatable sheet geometry
primitives.
ISheetSphere (p. 82) Defines a sheet sphere primitive.
ISolidBox (p. 83) Defines a solid box primitive.
ISolidCone (p. 83) Defines a solid cone primitive.
ISolidCylinder (p. 85) Defines a solid cylinder primitive.
ISolids (p. 85) Defines the list of all creatable solid geometry
primitives.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
Ansys.ACT.Interfaces.DesignModeler Namespace

ISolidSphere (p. 88) Defines a solid sphere primitive.

ISubtract (p. 88) Defines a "Subtract" operation.
IUnion (p. 89) Defines an "Union" operation.
IWireArc (p. 89) Defines a wire arc primitive.
IWireBCurve (p. 91) Defines awire b-curve primitive.
IWireEllipse (p. 91) Defines a wire ellipse primitive.
IWirePolyline (p. 93) Defines a wire polyline primitive.
IWires (p. 93) Defines the list of all creatable wire geometry
primitives.

IDesignModelerDataModel
Defines the DesignModeler data model.

Declaration Syntax
public interface IDesignModelerDataModel

Table 43: Members

Property Components (p. 60) Gets all components (named selections).

Property GeoData (p. 60) Gets the geometry data model object.
Property GeometryBuilder (p. 61) Gets the geometry builder object.
Property Queries (p. 61) Gets the queries object.
Method ComponentById(int) (p. 61) Returns the component (named selection)
associated to the specified identifier.
Method CurrentUnitFromQuantityName(string) (p. 61) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
60 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IDesignModelerExtAPI

IDesignModelerGeoData
Defines the DesignModeler geometry data model.

Declaration Syntax
public interface IDesignModelerGeoData

Table 44: Members

Property Bodies (p. 62) Gets all

bodies.
Property Parts (p. 62) 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 45: Members

Property Bodies (p. 63) Gets or sets the list of bodies or

parts generated by the feature.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
 IDesignModelerSelectionInfo

Property MaterialType (p. 63) Gets or sets the material type used
to generate the feature.
Method AddProblematicGeometry(IEnumerable<IPSGeoEntity>, Add a list of geometry entities has
string) (p. 63) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IDesignModelerSelectionInfo

Table 46: Members

Property Entities (p. 64) Gets the list of selected geometry entities.
Property Locations (p. 64) 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 47: Members

Property Depth (p. 64) Gets or Sets the depth of the extrusion.
Property Direction (p. 65) Gets or Sets the direction of the extrusion.
Property Walled (p. 65) Gets or Sets the walled flag.
Method ApplyTo(IPSGeoEntity) (p. 65) Applies the operation to the profile given in
argument.

Depth
Gets or Sets the depth of the extrusion.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
64 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 48: Members

Property Operations (p. 66) Gets the list of creatable

operations.
Property Primitives (p. 66) Gets the list of creatable
primitives.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
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 49: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 66) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
 IOperations

Declaration Syntax
public interface IOperations

Table 50: Members

Property Queries (p. 67) Gets the list of methods to

query information on the
geometry.
Property Tools (p. 67) Gets the list of additional
tools to manipulate the
geometry.
Method CreateExtrudeOperation(IEnumerable<double>, Creates an "Extrude"
double) (p. 67) operation.
Method CreateIntersectOperation(IEnumerable<IPSGeoBody>) (p. 68) Creates an "Intersect"
operation.
Method CreateRevolveOperation(IEnumerable<double>, Creates a "Revolve"
IEnumerable<double>) (p. 68) operation.
Method CreateSubtractOperation(IEnumerable<IPSGeoBody>) (p. 68) Creates a "Subtract"
operation.
Method CreateUnionOperation() (p. 69) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
68 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 51: Members

Method CopyBody(IPSGeoBody) (p. 70) Copies a body.

Method CreatePart(IEnumerable<IPSGeoBody>) (p. 70) Creates a new part (group of bodies).
Method DeleteBody(IPSGeoBody) (p. 70) Deletes a body.
Method EdgesToWireBody(IEnumerable<IPSGeoEdge>) (p. 70) Transforms a set of edges into a wire
body.
Method FacesToSheetBody(IEnumerable<IPSGeoFace>) (p. 71) Transforms a set of faces to a sheet
body.
Method Imprint(IPSGeoBody, Imprints a list of bodies to a target
IEnumerable<IPSGeoBody>) (p. 71) body.
Method OffsetFace(IEnumerable<IPSGeoFace>, double) (p. 71) Does a normal offset of faces with a
given offset value.
Method SheetBodyToSolidBody(IPSGeoBody) (p. 72) Transforms a sheet body to a solid
body.
Method SimplifyTopology(IPSGeoEntity) (p. 72) Simplifies the topology of the given
entity.
Method ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, Does a thicken operation on a body
double, double) (p. 72) and remove some faces.
Method TransformBody(IPSGeoBody, Matrix4D) (p. 73) Transform a body.
Method WireToSheetBody(IPSGeoBody) (p. 73) Transforms a wire body to a sheet
body.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
70 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
72 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
Ansys.ACT.Interfaces.DesignModeler Namespace

IPrimitives
Defines the list of creatable primitives.

Declaration Syntax
public interface IPrimitives

Table 52: Members

Property Sheet (p. 74)
Property Solid (p. 74)
Property Wire (p. 74)
Gets the list of all creatable sheet geometry
primitives.
Gets the list of all creatable solid geometry
primitives.
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
74 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IQueries

Table 53: Members

Method Clash(IEnumerable<IPSGeoEntity>, Detects clash between 2 sets of

IEnumerable<IPSGeoEntity>) (p. 76) geometry entities.
Method Coincidence(IPSGeoEntity, IPSGeoEntity) (p. 76) Checks if 2 geometry entities are
coincident.
Method Containment(IPSGeoEntity, IPSGeoEntity) (p. 77) Checks if one geometry entity contains
one other.
Method Distance(IEnumerable<IPSGeoEntity>, Computes the distance between 2 sets
IEnumerable<IPSGeoEntity>) (p. 77) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
76 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 54: Members

Property Angle (p. 78) Gets or sets the angle of the revolution.
Property Axis (p. 78) Gets or sets the axis of the revolution (x, y, z).
Property Origin (p. 78) Gets or sets the origin of the revolution (x, y, z).

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 77
Ansys.ACT.Interfaces.DesignModeler Namespace

Property Walled (p. 78) Gets or sets the walled flag.

Method ApplyTo(IPSGeoEntity) (p. 78) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
78 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 55: Members

Property Center (p. 79)
Property Direction (p. 79)
Property Radius1 (p. 79)
Property Radius2 (p. 80)
Gets or sets the center of the cone (x, y,
z).
Gets or sets the direction of the cone (x,
y, z).
Gets or sets the top radius of the cone.
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
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 56: Members

Property Center (p. 80) Gets or sets the center of the

cylinder.
Property Direction (p. 80) Gets or sets the axis of the
cylinder.
Property Radius (p. 80) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
80 of ANSYS, Inc. and its subsidiaries and affiliates.
 ISheets

ISheetPolygon
Defines a sheet polygon primitive.

Declaration Syntax
public interface ISheetPolygon

Table 57: Members

Property Points (p. 81) 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 58: Members

Method CreateCylinder(IEnumerable<double>, Creates a sheet cylinder primitive

IEnumerable<double>, double) (p. 81) generator.
Method CreatePolygon(IEnumerable<double>) (p. 82) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 81
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 59: Members

Property Center (p. 82) Gets or sets the center of the

sphere.
Property Radius (p. 83) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
82 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 60: Members

Property Point1 (p. 83) Gets or sets the first point of the box (x, y,
z).
Property Point2 (p. 83) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface ISolidCone

Table 61: Members

Property Center (p. 84)
Property Direction (p. 84)
Property Radius1 (p. 84)
Property Radius2 (p. 84)
Gets or sets the center of the cone (x, y,
z).
Gets or sets the direction of the cone (x,
y, z).
Gets or sets the top radius of the cone.
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
 ISolids

ISolidCylinder
Defines a solid cylinder primitive.

Declaration Syntax
public interface ISolidCylinder

Table 62: Members

Property Center (p. 85)
Property Direction (p. 85)
Property Radius (p. 85)
Gets or sets the center of the cylinder (x, y,
z).
Gets or sets the direction of the cylinder (x,
y, z).
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface ISolids

Table 63: Members

Method CreateBox(IEnumerable<double>, Creates a box primitive generator.

IEnumerable<double>) (p. 86)
Method CreateCone(IEnumerable<double>, Creates a cone primitive
IEnumerable<double>, double, double) (p. 86) generator.
Method CreateCylinder(IEnumerable<double>, Creates a cylinder primitive
IEnumerable<double>, double) (p. 87) generator.
Method CreateSphere(IEnumerable<double>, double) (p. 87) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
86 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
Ansys.ACT.Interfaces.DesignModeler Namespace

ISolidSphere
Defines a solid sphere primitive.

Declaration Syntax
public interface ISolidSphere

Table 64: Members

Property Center (p. 88) Gets or sets the center of the sphere (x,
y, z).
Property Radius (p. 88) 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 65: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 88) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
88 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 66: Members

Method ApplyTo(IEnumerable<IPSGeoBody>) (p. 89) 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 67: Members

Property Center (p. 90) Gets or sets the center of the arc (x, y, z).

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
Ansys.ACT.Interfaces.DesignModeler Namespace

Property EndAngle (p. 90)
Property Normal (p. 90)
Property Radius (p. 90)
Property StartAngle (p. 90)
Property XDir (p. 91)
Gets or sets the end angle of the arc.
Gets or sets the normal of the arc (x, y, z).
Gets or sets the radius of the arc.
Gets or sets the start angle of the arc.
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
90 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 68: Members

Property Closed (p. 91) Gets of sets the closed flag.

Property Points (p. 91) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
Ansys.ACT.Interfaces.DesignModeler Namespace

Declaration Syntax
public interface IWireEllipse

Table 69: Members

Property Center (p. 92)
Property LargeRadius (p. 92)
Property Normal (p. 92)
Property SmallRadius (p. 92)
Property XDir (p. 93)
Gets or sets the center of the ellipse (x, y, z).
Gets or sets the large radius of the ellipse.
Gets or sets the normal direction of the ellipse (x,
y, z).
Gets or sets the small radius of the ellipse.
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
92 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 70: Members

Property Points (p. 93) 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 71: Members

Method CreateArc(double, IEnumerable<double>, Creates an arc primitive

IEnumerable<double>, IEnumerable<double>) (p. 94) generator.
Method CreateBCurve(IEnumerable<double>) (p. 94) Creates a b-curve primitive
generator.
Method CreateEllipse(double, double, IEnumerable<double>, Creates an ellipse primitive
IEnumerable<double>, IEnumerable<double>) (p. 94) generator.
Method CreatePolyline(IEnumerable<double>) (p. 95) Creates a polyline primitive
generator.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 93
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
94 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
96 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Graphics

Table 72: Members

IModelViewManager (p. 97) No details are provided for this

entry.

IModelViewManager
No details are provided for this entry.

Declaration Syntax
public interface IModelViewManager

Table 73: Members

Property NumberOfViews (p. 98) The number of views currently defined.

Method ApplyModelView(int) (p. 98) Apply the view specified by index.
Method ApplyModelView(string) (p. 98) Apply the view specified by name.
Method CaptureModelView(int, string) (p. 98) Save the view specified by index as a PNG image
to the project userfiles.
Method CaptureModelView(string, string) (p. 99) Save the view specified as an image to the
project userfiles.
Method CreateView() (p. 99) Create a view from current graphics with default
naming.
Method CreateView(string) (p. 99) Create a view from current graphics with the
specified name.
Method DeleteView(int) (p. 99) Delete the specified view by index.
Method DeleteView(string) (p. 100) Apply the view specified by name.
Method ExportModelViews(string) (p. 100) Export model views to the specified file.
Method ImportModelViews(string) (p. 100) Import model views from the specified file.
Method RenameView(int, string) (p. 101) Rename the model view specified by viewIndex
to newLabel.
Method RenameView(string, string) (p. 101) Rename the model view specified to newLabel.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
98 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
100 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 101
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
102 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Interfaces.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Interfaces.Mechanical

Table 74: Members

IMechanicalDataModel (p. 103) Defines the data model of the Mechanical

application.
IMechanicalExtAPI (p. 105) Exposes the main entry point of all ATC APIs.
IMechanicalGraphics (p. 105) Interface for MechanicalGraphics.
IMechanicalSelectionInfo (p. 106) Defines the mechanical selection information.
IMechanicalUserLoad (p. 107) Defines a Mechanical user load.
IMechanicalUserObject (p. 107) Defines a Mechanical user object.
IMechanicalUserResult (p. 107) Defines a Mechanical user result.
IMechanicalUserSolver (p. 108) Defines a Mechanical user solver.
MechanicalPanelEnum (p. 108) Specifies the panel type.

IMechanicalDataModel
Defines the data model of the Mechanical application.

Declaration Syntax
public interface IMechanicalDataModel

Table 75: Members

Property ObjectTags (p. 104) Gets the ObjectTags object for the Data
Model, which represents the current list of
tags visable in the User Interface.
Property Project (p. 104) Gets the project object. Main object of the
tree of Mechanical.
Property Tree (p. 104) Gets the tree of Mechanical.
Method CurrentUnitFromQuantityName(string) (p. 104) Returns the current unit from a quantity
name.
Method GetUserObjectById(int) (p. 104) Gets the user object based on the application
id.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 103
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
104 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 76: Members

Method LockPrePostLicense() (p. 105) Locks the license used by the PRE/POST application.
Method UnlockPrePostLicense() (p. 105) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 105
Ansys.ACT.Interfaces.Mechanical Namespace

Declaration Syntax
public interface IMechanicalGraphics

Table 77: Members

Property ModelViewManager (p. 106) An instance of the

ModelViewManager.
Property SectionPlanes (p. 106) 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 78: Members

Property ElementFaceIndices (p. 106) Gets the list indices needed to define the face of an
element.
Property Entities (p. 107) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
106 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 79: Members

Property Analysis (p. 107) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 107
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 80: 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Common Namespace
Declaration Syntax
namespace Ansys.ACT.Common

Table 81: Members

CoordinateSystem (p. 109) CoordinateSystem class

SimpleTransform (p. 111) Exposes simple getters and setters for rigid body
transformations.

CoordinateSystem
CoordinateSystem class

Declaration Syntax
public class CoordinateSystem : ICoordinateSystem

Table 82: Members

Constructor CoordinateSystem(CoordinateSystemTypeEnum) (p. 110) Constructor.

Property CoordinateSystemType (p. 110) Gets or sets the coordinate
system type.
Property Id (p. 110) Gets or sets the ID of the
coordinate system.
Property Matrix (p. 110) Gets or sets the matrix
definition of the coordinate
system.
Property Name (p. 110) Gets or sets the name of the
coordinate system.
Property Origin (p. 111) Gets or sets the origin of the
coordinate system.
Property XAxis (p. 111) Gets or sets the X axis of the
coordinate system.
Property YAxis (p. 111) Gets or sets the Y axis of the
coordinate system.
Property ZAxis (p. 111) Gets or sets the Z axis of the
coordinate system.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 109
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
110 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 83: Members

Constructor SimpleTransform() (p. 112) No details are provided for this entry.
Property IsOrthonormal (p. 112) Returns `true` if the provided axis vectors are all normalized
and orthogonal.
Property TransformationMatrix (p. 112) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 111
Ansys.ACT.Common Namespace

Property Translation (p. 112) The translation of the transformation with respect to the
global/world coordinate system.
Property XAxis (p. 112) The X-axis orientation of the transformation with respect
to the global/world coordinate system.
Property YAxis (p. 113) The Y-axis orientation of the transformation with respect
to the global/world coordinate system.
Property ZAxis (p. 113) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
112 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 113
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Common.Graphics Namespace
Declaration Syntax
namespace Ansys.ACT.Common.Graphics

Table 84: Members

DMCameraWrapper (p. 115) Wrapper for Camera in Design

Modeler.
DMGraphicsWrapper (p. 115) Wrapper for Graphics in Design
Modeler.
MechanicalCameraWrapper (p. 115) Wrapper for Camera in Mechanical.
MechanicalGraphicsWrapper (p. 119) Wrapper for Graphics in Mechanical.
ModelViewManager (p. 122) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 115
Ansys.ACT.Common.Graphics Namespace

Declaration Syntax
public class MechanicalCameraWrapper : CameraWrapper

Table 85: Members

Property FocalPoint (p. 116) The focal point of the camera

(coordinates are in the global
coordinate system).
Property SceneHeight (p. 116) Specifies the scene height (in
length units) that will be
projected and fit to the viewport.
Property SceneWidth (p. 117) Specifies the scene width (in
length units) that will be
projected and fit to the viewport.
Property UpVector (p. 117) The vector pointing up from the
focal point.
Property ViewVector (p. 117) The vector pointing from the focal
point to the camera.
Method GetAsString(ApplicationType) (p. 117) Retrieves the view commands as
related to the application type as
a string.
Method Pan(Quantity, Quantity) (p. 117) Shifts the camera position
horizontally or vertically based on
x and y quantities.
Method Rotate(double, CameraAxisType) (p. 118) Rotates the camera about an axis.
Method SetFit(ISelectionInfo) (p. 118) Fits the view to the specified
selection. If null is supplied, fits
the view to the entire model.
Method SetSpecificViewOrientation(ViewOrientationType) (p. 118)Sets a specific view orientation.
Method Zoom(double) (p. 119) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
116 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 117
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
118 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 86: Members

Property Camera (p. 120) Gets the camera.

Property GlobalLegendSettings (p. 120) Gets the Global Graphics Legend Settings.
Property KeyframeAnimationUtility (p. 120) A utility for creating animations based on
keyframes.
Property ModelViewManager (p. 120) An instance of the ModelViewManager.
Property ResultAnimationOptions (p. 120) Gets the Global Result Animation options.
Property SectionPlanes (p. 120) Returns the collection of section planes used
by graphics
Property Unit (p. 121) Gets the current graphics unit.
Property ViewOptions (p. 121) Gets the Graphics View Options.
Method Export3D(string, Graphics3DExportFormat, Exports the current Graphics display in a 3d
Graphics3DExportSettings) (p. 121) format to a file.
Method ExportImage(string, Exports the current graphics display to a 2D
GraphicsImageExportFormat, image file.
GraphicsImageExportSettings) (p. 121)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 119
Ansys.ACT.Common.Graphics Namespace

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

Declaration Syntax
public SectionPlanes SectionPlanes { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
120 of ANSYS, Inc. and its subsidiaries and affiliates.
 MechanicalGraphicsWrapper

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.

Declaration Syntax
public void ExportImage(string filePath, GraphicsImageExportFormat formatImage, GraphicsImageEx-
portSettings settings)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 121
Ansys.ACT.Common.Graphics Namespace

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.

ModelViewManager
No details are provided for this entry.

Declaration Syntax
public class ModelViewManager : IModelViewManager

Table 87: Members

Property ActiveViewPort (p. 123)
Property NumberOfViews (p. 123)
Method ApplyModelView(int) (p. 123)
Method ApplyModelView(string) (p. 123)
Method CreateView() (p. 123)
Method CreateView(string) (p. 124)
Method DeleteView(int) (p. 124)
Method DeleteView(string) (p. 124)
Method ExportModelViews(string) (p. 124)
Method ImportModelViews(string) (p. 125)
Method RenameView(int, string) (p. 125)
Method RenameView(string, string) (p. 125) Rename the model view specified to newLabel.
Method SetActiveViewPort(int) (p. 126)
Method SetActiveViewPort(int, int) (p. 126)
Method SetViewPorts(int, bool) (p. 126)
No details are provided for this entry.
The number of views currently defined.
Apply the view specified by index.
Apply the view specified by name.
Create a view from current graphics with default
naming.
Create a view from current graphics with the specified
name.
Delete the specified view by index.
Delete the specified view by name.
Export model views to the specified file.
Import model views from the specified file.
Rename the model view specified by viewIndex to
newLabel.
Active a viewport.
Set the active of viewport.
Set the number of viewports displayed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
122 of ANSYS, Inc. and its subsidiaries and affiliates.
 ModelViewManager

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 123
Ansys.ACT.Common.Graphics Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
124 of ANSYS, Inc. and its subsidiaries and affiliates.
 ModelViewManager

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 125
Ansys.ACT.Common.Graphics Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
126 of ANSYS, Inc. and its subsidiaries and affiliates.
 ModelViewManager

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 127
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
128 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.DesignModeler Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.DesignModeler

Table 88: Members

Extrusion (p. 129) Defines a Extrusion.

Feature (p. 130) Defines a Feature.
FeatureManager (p. 131) Defines a
FeatureManager.
NamedSelection (p. 132) Defines a
NamedSelection.

Extrusion
Defines a Extrusion.

Declaration Syntax
public class Extrusion : Feature

Table 89: Members

Property Depth (p. 130) Gets or sets the Depth.

Property Depth2 (p. 130) Gets or sets the Depth2.
Property Id (p. 131) Gets the id of the feature.

(Inherited from
Feature (p. 130).)
Property Name (p. 131) Gets the name of the
feature.

(Inherited from
Feature (p. 130).)
Property Thin1 (p. 130) Gets or sets the Thin1.
Property Thin2 (p. 130) Gets or sets the Thin2.
Property Walled (p. 130) Gets or sets the Walled.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 129
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
130 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureManager

Declaration Syntax
public class Feature

Table 90: Members

Property Id (p. 131) Gets the id of the

feature.
Property Name (p. 131) 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 91: Members

Property Count (p. 131) Gets the number of features.

Property Item (p. 132) Gets a feature by its index.
Method CreateNamedSelection() (p. 132) Creates a new NamedSelection
feature.
Method Generate() (p. 132) Generates non-generated features
if any.

Count
Gets the number of features.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 131
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 92: Members

Property ExportNamedSelection (p. 133) Gets or sets the

ExportNamedSelection.
Property Id (p. 131) Gets the id of the feature.

(Inherited from Feature (p. 130).)

Property IncludeInLegend (p. 133) Gets or sets the IncludeInLegend.
Property Name (p. 131) Gets the name of the feature.

(Inherited from Feature (p. 130).)

Property NumGeometry (p. 133) Gets the NumGeometry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
132 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelection

Property PropagateNamedSelection (p. 133) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 133
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
134 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical

Table 93: Members

AcousticsFarFieldResultWorksheet (p. 140) No details are provided for this entry.

AMOverhangConstraint (p. 145) Defines a AMOverhangConstraint.
Analysis (p. 146) Defines a Analysis.
AnalysisPly (p. 182) Defines a AnalysisPly.
ArbitraryCrack (p. 186) Defines a ArbitraryCrack.
BatchConnectionsWorksheet (p. 191) No details are provided for this entry.
Body (p. 196) Defines a Body.
CenterOfGravityConstraint (p. 215) Defines a CenterOfGravityConstraint.
ChannelCrossSection (p. 217) Defines a ChannelCrossSection.
Chart (p. 220) Defines a Chart.
ChartXAxis (p. 225) No details are provided for this entry.
CircularCrossSection (p. 226) Defines a CircularCrossSection.
CircularTubeCrossSection (p. 227) Defines a CircularTubeCrossSection.
CommandSnippet (p. 229) Defines a CommandSnippet.
Comment (p. 238) Defines a Comment.
ComplianceConstraint (p. 240) Defines a ComplianceConstraint.
CompositeCriterion (p. 241) Defines a CompositeCriterion.
CompositeCriterionDefinition (p. 243) No details are provided for this entry.
CompositeCriterionTerm (p. 245) No details are provided for this entry.
CondensedGeometry (p. 247) Defines a CondensedGeometry.
CondensedPart (p. 251) Defines a CondensedPart.
CondensedPartBase (p. 257) Defines a CondensedPartBase.
CondensedPartExpansionState (p. 263) No details are provided for this entry.
CondensedPartInfoTool (p. 264) Defines a CondensedPartInfoTool.
CondensedPartInterface (p. 267) No details are provided for this entry.
CondensedPartInterfaces (p. 268) A collection of condensed part interface.
ConstructionGeometry (p. 269) Defines a ConstructionGeometry.
ConstructionPoint (p. 275) Defines a ConstructionPoint.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 135
Ansys.ACT.Automation.Mechanical Namespace

ContactDebonding (p. 279) Defines a ContactDebonding.

ContactMatch (p. 282) Defines a ContactMatch.
ContactMatchGroup (p. 284) Defines a ContactMatchGroup.

Defines a ContactMatchGroup.
ContactSolutionInformation (p. 286) Defines a ContactSolutionInformation.
CoordinateSystem (p. 290) Defines a CoordinateSystem.
CoordinateSystems (p. 305) Defines a CoordinateSystems.
CoSimulationPin (p. 308) Defines a CoSimulationPin.
Crack ***OBSOLETE*** Deprecated class. Use Defines a Crack.
ArbitraryCrack or SemiEllipticalCrack
instead. (p. 311)
Criterion (p. 317) Defines a Criterion.
CriterionConstraint (p. 321) Defines a CriterionConstraint.
CrossSection (p. 322) Defines a CrossSection.
CrossSections (p. 326) Defines a CrossSections.
CyclicManufacturingConstraint (p. 331) Defines a CyclicManufacturingConstraint.
CyclicRegion (p. 333) Defines a CyclicRegion.
DirectMorph (p. 334) Defines a DirectMorph.
DisplacementConstraint (p. 338) Defines a DisplacementConstraint.
DistributedMass (p. 339) Defines a DistributedMass.
DynamicComplianceConstraint (p. 341) Defines a DynamicComplianceConstraint.
ElementOrientation (p. 343) Defines a ElementOrientation.
EllipticalCrack (p. 348) Defines a EllipticalCrack.
EndRelease (p. 354) Defines a EndRelease.
ExclusionRegion (p. 359) Defines a ExclusionRegion.
ExpansionSettings (p. 361) Defines a ExpansionSettings.
ExternalEnhancedModel (p. 368) Defines a ExternalEnhancedModel.
ExternalModelDataColl (p. 372) Defines a ExternalModelDataColl.
ExtrusionManufacturingConstraint (p. 376) Defines a ExtrusionManufacturingConstraint.
FatigueCombination (p. 377) Defines a FatigueCombination.
FatigueTool (p. 381) Defines a FatigueTool.
FeatureDetection (p. 390) Defines a FeatureDetection.
FeatureDetectionDefinition (p. 394) No details are provided for this entry.
Figure (p. 404) Defines a Figure.
Fracture (p. 407) Defines a Fracture.
GeneralAxisymmetric (p. 412) Defines a GeneralAxisymmetric.
GenericCrack (p. 417) Defines a GenericCrack.
GenericDelamination (p. 421) Defines a GenericDelamination.
GenericPointMass (p. 424) Defines a GenericPointMass.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
136 of ANSYS, Inc. and its subsidiaries and affiliates.
Geometry (p. 428) Defines a Geometry.
GeometryFileContainer (p. 448) Defines a GeometryFileContainer.
GeometryImport (p. 452) Defines a GeometryImport.
GeometryImportGroup (p. 457) Defines a GeometryImportGroup.
GlobalVonMisesStressConstraint (p. 461) Defines a GlobalVonMisesStressConstraint.

Defines a GlobalVonMisesStressConstraint.
HatCrossSection (p. 462) Defines a HatCrossSection.
HollowRectangularCrossSection (p. 466) Defines a HollowRectangularCrossSection.
HousingConstraint (p. 468) Defines a HousingConstraint.

Defines a HousingConstraint.
ICrossSection (p. 470) Defines a ICrossSection.
Image (p. 473) Defines a Image.
ImagePlane (p. 476) Defines a ImagePlane.
ImportedBoltPretensions (p. 481) Defines a ImportedBoltPretensions.
ImportedCondensedPart (p. 482) Defines a ImportedCondensedPart.
ImportedConstraintEquations (p. 490) Defines a ImportedConstraintEquations.
ImportedContacts (p. 492) Defines a ImportedContacts.
ImportedCoordinateSystems (p. 493) Defines a ImportedCoordinateSystems.
ImportedElementOrientations (p. 494) Defines a ImportedElementOrientations.
ImportedFlexibleRemoteConnectors (p. 495) Defines a ImportedFlexibleRemoteConnectors.
ImportedLayeredSection (p. 496) Defines a ImportedLayeredSection.
ImportedNodalOrientations (p. 498) Defines a ImportedNodalOrientations.
ImportedObject (p. 499) Defines a row object in Imported Objects.
ImportedPlies (p. 500) Defines a ImportedPlies.
ImportedPliesCollection (p. 502) Defines a ImportedPliesCollection.
ImportedPointMasses (p. 505) Defines a ImportedPointMasses.
ImportedPremeshedBoltPretensions (p. 506) Defines a ImportedPremeshedBoltPretensions.
ImportedRigidRemoteConnectors (p. 507) Defines a ImportedRigidRemoteConnectors.
ImportedShellThicknesses (p. 508) Defines a ImportedShellThicknesses.
ImportedSpringConnectors (p. 510) Defines a ImportedSpringConnectors.
ImportedStresses (p. 511) Defines a ImportedStresses.
InitialCondition (p. 512) Defines a InitialCondition.
InitialConditions (p. 524) Defines a InitialConditions.
InterfaceDelamination (p. 528) Defines a InterfaceDelamination.
JointBushingWorksheet (p. 532) The worksheet of stiffness and damping
coefficients for a bushing type joint.
LayeredSection (p. 541) Defines a LayeredSection.
LayeredSectionWorksheet (p. 547) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 137
Ansys.ACT.Automation.Mechanical Namespace

LCrossSection (p. 552) Defines a LCrossSection.

LocalVonMisesStressConstraint (p. 554) Defines a LocalVonMisesStressConstraint.
ManufacturingConstraint (p. 556) Defines a ManufacturingConstraint.

Defines a ManufacturingConstraint.
MappingValidation (p. 558) Defines a MappingValidation.
MassConstraint (p. 565) Defines a MassConstraint.
Material (p. 567) Defines a Material.
MaterialAssignment (p. 571) Defines a MaterialAssignment.
MaterialPlot (p. 577) Defines a MaterialPlot.
Materials (p. 580) Defines a Materials.
MemberSizeManufacturingConstraint (p. 584) Defines a MemberSizeManufacturingConstraint.
MeshConnection (p. 587) Defines a MeshConnection.
MeshConnectionBase (p. 590) Defines a MeshConnectionBase.

Defines a MeshConnectionBase.
MeshConnectionGroup (p. 596) Defines a MeshConnectionGroup.
MeshControlWorksheet (p. 599) No details are provided for this entry.
MeshEdit (p. 603) Defines a MeshEdit.
MeshExtrude (p. 610) 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. 619) Defines a MeshNumbering.
Model (p. 623) Defines a Model.
MomentOfInertiaConstraint (p. 652) Defines a MomentOfInertiaConstraint.
NamedSelection (p. 655) Defines a NamedSelection.
NamedSelectionCriteria (p. 663) A collection of named selection criteria.
NamedSelectionCriterion (p. 666) No details are provided for this entry.
NamedSelections (p. 669) Defines a NamedSelections.
NastranExportOptions (p. 674) Defines the NastranExportOptions.
NaturalFrequencyConstraint (p. 678) Defines a NaturalFrequencyConstraint.
NodeMerge (p. 679) Defines a NodeMerge.

Defines a NodeMerge.
NodeMergeGroup (p. 684) Defines a NodeMergeGroup.
NodeMove (p. 687) Defines a NodeMove.
NumberingControl (p. 692) Defines a NumberingControl.
Objective (p. 697) Defines a Objective.
ObjectiveWorksheet (p. 701) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
138 of ANSYS, Inc. and its subsidiaries and affiliates.
OptimizationRegion (p. 710) Defines a OptimizationRegion.
OptimizationRegionBaseClass (p. 715) Defines a OptimizationRegionBaseClass.
ParameterVariable (p. 717) Defines a ParameterVariable.
ParameterVariableGroup (p. 720) Defines a ParameterVariableGroup.
Part (p. 723) Defines a Part.
PartTransform (p. 733) Defines a PartTransform.
PartTransformGroup (p. 739) Defines a PartTransformGroup.
Path (p. 743) Defines a Path.
PatternRepetitionConstraint (p. 751) Defines a PatternRepetitionConstraint.
PeriodicRegion (p. 752) Defines a PeriodicRegion.
PhysicsRegion (p. 754) Defines a PhysicsRegion.
PipeIdealization (p. 761) Defines a PipeIdealization.
PointMass (p. 764) Defines a PointMass.
PostContactTool (p. 768) Defines a PostContactTool.
PreContactTool (p. 770) Defines a PreContactTool.
PreMeshedCrack (p. 772) Defines a PreMeshedCrack.
PreMeshedCyclicRegion (p. 775) Defines a PreMeshedCyclicRegion.
PrimaryCriterion (p. 777) Defines a PrimaryCriterion.
Project (p. 781) Defines a Project.
PullOutDirectionManufacturingConstraint (p. 788) Defines a
PullOutDirectionManufacturingConstraint.
PythonCode (p. 790) Defines a PythonCode.
PythonCodeEventBased (p. 792) Defines a PythonCodeEventBased.
ReactionForceConstraint (p. 794) Defines a ReactionForceConstraint.
RectangularCrossSection (p. 796) Defines a RectangularCrossSection.
RemotePoint (p. 798) Defines a RemotePoint.
RemotePoints (p. 806) Defines a RemotePoints.

Defines a RemotePoints.
ResponseConstraint (p. 809) Defines a ResponseConstraint.
ResponsePSDTool (p. 812) Defines a ResponsePSDTool.
ResultMesh (p. 816) Defines a ResultMesh.
RingCrack (p. 821) Defines a RingCrack.
SelectionWorksheet (p. 828) No details are provided for this entry.
SemiEllipticalCrack (p. 840) Defines a SemiEllipticalCrack.
SMARTCrackGrowth (p. 846) Defines a SMARTCrackGrowth.
Solid (p. 852) Defines a Solid.
Solution (p. 856) Defines a Solution.
SolutionCombination (p. 932) Defines a SolutionCombination.
SolutionCombinationDefinition (p. 947) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 139
Ansys.ACT.Automation.Mechanical Namespace

SolutionInformation (p. 956) Defines a SolutionInformation.

Stage (p. 980) Defines a Stage.
STL (p. 986) Defines a STL.
SubstructureGenerationCondensedPart (p. 989) Defines a SubstructureGenerationCondensedPart.
Surface (p. 992) Defines a Surface.
SurfaceCoating (p. 996) Defines a SurfaceCoating.
Symmetry (p. 1000) Defines a Symmetry.
SymmetryGeneral (p. 1005) Defines a SymmetryGeneral.
SymmetryManufacturingConstraint (p. 1010) Defines a SymmetryManufacturingConstraint.
SymmetryRegion (p. 1011) Defines a SymmetryRegion.
Table (p. 1014) Defines a Table.
TableGroup (p. 1019) Defines a TableGroup.
TCrossSection (p. 1022) Defines a TCrossSection.
TemperatureConstraint (p. 1024) Defines a TemperatureConstraint.
ThermalComplianceConstraint (p. 1025) Defines a ThermalComplianceConstraint.
ThermalPointMass (p. 1026) Defines a ThermalPointMass.
Thickness (p. 1029) Defines a Thickness.
Tree (p. 1034) No details are provided for this entry.
TreeGroupingFolder (p. 1041) Defines a TreeGroupingFolder.
UniformConstraint (p. 1044) Defines a UniformConstraint.
UserDefinedCrossSection (p. 1045) Defines a UserDefinedCrossSection.
VirtualCell (p. 1048) Defines a VirtualCell.
VirtualTopology (p. 1052) Defines a VirtualTopology.
VolumeConstraint (p. 1063) Defines a VolumeConstraint.
Worksheet (p. 1066) No details are provided for this entry.
ZCrossSection (p. 1066) Defines a ZCrossSection.

AcousticsFarFieldResultWorksheet
No details are provided for this entry.

Declaration Syntax
public class AcousticsFarFieldResultWorksheet : Worksheet

Table 94: Members

Property RowCount (p. 141) Return the number of entries.

Method AddRow() (p. 141) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 141) Deletes a row from the worksheet at index.
Method DuplicateRow(int, int) (p. 141) Insert a row from the worksheet at index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
140 of ANSYS, Inc. and its subsidiaries and affiliates.
 AcousticsFarFieldResultWorksheet

Method GetCoordinateSystemSelection(int) (p. 142) Gets the worksheet CoordinateSystemSelection

property at index.
Method GetXCoordinate(int) (p. 142) Gets the worksheet Mic X property at index.
Method GetYCoordinate(int) (p. 142) Gets the worksheet Mic Y property at index.
Method GetZCoordinate(int) (p. 143) Gets the worksheet Mic Z property at index.
Method InsertRow(int) (p. 143) Insert a row from the worksheet at index.
Method SetCoordinateSystemSelection(int, Sets the worksheet CoordinateSystemSelection
uint) (p. 143) property at index.
Method SetXCoordinate(int, double) (p. 144) Sets the worksheet Mic X property at index.
Method SetYCoordinate(int, double) (p. 144) Sets the worksheet Mic Y property at index.
Method SetZCoordinate(int, double) (p. 144) 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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 141
Ansys.ACT.Automation.Mechanical Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
142 of ANSYS, Inc. and its subsidiaries and affiliates.
 AcousticsFarFieldResultWorksheet

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 143
Ansys.ACT.Automation.Mechanical Namespace

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
144 of ANSYS, Inc. and its subsidiaries and affiliates.
 AMOverhangConstraint

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 95: Members

Property BuildDirection (p. 145) Gets or sets the BuildDirection.

Property Children (p. 556) Gets the list of children.

Property CoordinateSystem (p. 146)
Property DataModelObjectCategory (p. 146)Gets the current DataModelObject's
category.
Property InternalObject (p. 146)
Property OverhangAngle (p. 146)
Property ScopingMethod (p. 146)
Property Selection (p. 557)
(Inherited from
ManufacturingConstraint (p. 556).)
Gets or sets the CoordinateSystem.
Gets the internal object. For advanced usage
only.
Gets or sets the OverhangAngle.
Gets or sets the ScopingMethod.
Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

BuildDirection
Gets or sets the BuildDirection.

Declaration Syntax
public CoordinateSystemAxisType BuildDirection { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 145
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Analysis
Defines a Analysis.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
146 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public class Analysis : DataModelObject, IAnalysis, IDataModelObject, IApplicationObject, IDataObject-
Container, IInternalDataObjectContainer, IExtensionDMOperationRecorder, IFolderDataModelObject

Table 96: Members

Property Acoustics (p. 151) Gets or sets the Acoustics.

Property AMProcessSimulation (p. 152) Gets or sets the AMProcessSimulation.
Property AnalysisSettings (p. 152) Gets the AnalysisSettings.
Property AnalysisType (p. 152) Gets the AnalysisType.
Property CellId (p. 152) Gets the CellId.
Property Children (p. 152) Gets the list of children.
Property Comments (p. 152) Gets the list of associated comments.
Property DataModelObjectCategory (p. 153) Gets the current DataModelObject's category.
Property Electric (p. 153) Gets the Electric.
Property EnvironmentTemperature (p. 153) Gets or sets the EnvironmentTemperature.
Property Figures (p. 153) Gets the list of associated figures.
Property GenerateInputOnly (p. 153) Gets the GenerateInputOnly.
Property Images (p. 153) Gets the list of associated images.
Property InitialConditions (p. 154) Get InitialConditions.
Property InternalObject (p. 154) Gets the internal object. For advanced usage only.
Property PhysicsType (p. 154) Gets the PhysicsType.
Property ResultFileName (p. 154) Get the full path and name of the result file.
Property Solution (p. 154) Gets the Solution.
Property Structural (p. 154) Gets or sets the Structural.
Property SystemCaption (p. 155) Gets the SystemCaption.
Property Thermal (p. 155) Gets the Thermal.
Method AddAcceleration() (p. 155) Creates a new Acceleration
Method AddAcousticAbsorptionElement() (p. 155) Creates a new AcousticAbsorptionElement
Method AddAcousticAbsorptionSurface() (p. 155) Creates a new AcousticAbsorptionSurface
Method AddAcousticDiffuseSoundField() (p. 155) Creates a new AcousticDiffuseSoundField
Method AddAcousticFarFieldRadationSurface() (p. 156) Creates a new AcousticFarFieldRadationSurface
Method AddAcousticFreeSurface() (p. 156) Creates a new AcousticFreeSurface
Method AddAcousticImpedanceBoundary() (p. 156) Creates a new AcousticImpedanceBoundary
Method AddAcousticImpedanceSheet() (p. 156) Creates a new AcousticImpedanceSheet
Method AddAcousticIncidentWaveSource() (p. 156) Creates a new AcousticIncidentWaveSource
Method AddAcousticLowReducedFrequency() (p. 156) Creates a new AcousticLowReducedFrequency
Method AddAcousticMassSource() (p. 157) Creates a new AcousticMassSource
Method AddAcousticMassSourceRate() (p. 157) Creates a new AcousticMassSourceRate
Method AddAcousticPort() (p. 157) Creates a new AcousticPort

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 147
Ansys.ACT.Automation.Mechanical Namespace

Method AddAcousticPortInDuct() (p. 157) Creates a new AcousticPortInDuct

Method AddAcousticPressure() (p. 157) Creates a new AcousticPressure
Method AddAcousticRadiationBoundary() (p. 157) Creates a new AcousticRadiationBoundary
Method AddAcousticRigidWall() (p. 158) Creates a new AcousticRigidWall
Method AddAcousticStaticPressure() (p. 158) Creates a new AcousticStaticPressure
Method AddAcousticSurfaceAcceleration() (p. 158) Creates a new AcousticSurfaceAcceleration
Method AddAcousticSurfaceVelocity() (p. 158) Creates a new AcousticSurfaceVelocity
Method AddAcousticSymmetryPlane() (p. 158) Creates a new AcousticSymmetryPlane
Method AddAcousticTemperature() (p. 158) Creates a new child ThermalCondition.
Method AddAcousticThermoViscousBLIBoundary() (p. 159) Creates a new AcousticThermoViscousBLIBoundary
Method AddAcousticTransferAdmittanceMatrix() (p. 159) Creates a new AcousticTransferAdmittanceMatrix
Method AddAMOverhangConstraint() (p. 159) Creates a new AMOverhangConstraint
Method AddBearingLoad() (p. 159) Creates a new BearingLoad
Method AddBodyControl() (p. 159) Creates a new BodyControl
Method AddBoltPretension() (p. 159) Creates a new BoltPretension
Method AddCenterOfGravityConstraint() (p. 160) Creates a new CenterOfGravityConstraint
Method AddCommandSnippet() (p. 160) Creates a new CommandSnippet
Method AddComment() (p. 160) Creates a new child Comment.
Method AddComplianceConstraint() (p. 160) Creates a new ComplianceConstraint
Method AddCompressionOnlySupport() (p. 160) Creates a new CompressionOnlySupport
Method AddConstraintEquation() (p. 160) Creates a new ConstraintEquation
Method AddContactStepControl() (p. 161) Creates a new ContactStepControl
Method AddConvection() (p. 161) Creates a new Convection
Method AddCoupling() (p. 161) Creates a new Coupling
Method AddCriterionConstraint() (p. 161) Creates a new CriterionConstraint
Method AddCurrent() (p. 161) Creates a new Current
Method AddCyclicManufacturingConstraint() (p. 161) Creates a new CyclicManufacturingConstraint
Method AddCylindricalSupport() (p. 162) Creates a new CylindricalSupport
Method AddDetonationPoint() (p. 162) Creates a new DetonationPoint
Method AddDisplacement() (p. 162) Creates a new Displacement
Method AddDisplacementConstraint() (p. 162) Creates a new DisplacementConstraint
Method AddDynamicComplianceConstraint() (p. 162) Creates a new DynamicComplianceConstraint
Method AddEarthGravity() (p. 162) Creates a new EarthGravity
Method AddElasticSupport() (p. 163) Creates a new ElasticSupport
Method AddElectricCharge() (p. 163) Creates a new ElectricCharge
Method AddElementBirthAndDeath() (p. 163) Creates a new ElementBirthAndDeath
Method AddEMTransducer() (p. 163) Creates a new EMTransducer
Method AddExtrusionManufacturingConstraint() (p. 163) Creates a new ExtrusionManufacturingConstraint
Method AddFigure() (p. 163) Creates a new child Figure.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
148 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Method AddFixedRotation() (p. 164) Creates a new FixedRotation

Method AddFixedSupport() (p. 164) Creates a new FixedSupport
Method AddFluidSolidInterface() (p. 164) Creates a new FluidSolidInterface
Method AddForce() (p. 164) Creates a new Force
Method AddFrictionlessSupport() (p. 164) Creates a new FrictionlessSupport
Method AddGeneralizedPlaneStrain() (p. 164) Creates a new GeneralizedPlaneStrain
Method AddGlobalVonMisesStressConstraint() (p. 165) Creates a new GlobalVonMisesStressConstraint
Method AddHeatFlow() (p. 165) Creates a new HeatFlow
Method AddHeatFlux() (p. 165) Creates a new HeatFlux
Method AddHousingConstraint() (p. 165) Creates a new HousingConstraint
Method AddHydrostaticPressure() (p. 165) Creates a new HydrostaticPressure
Method AddImage(string) (p. 165) 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. 166) Creates a new ImpedanceBoundary
Method AddImportedCFDPressure() (p. 166) Creates a new ImportedCFDPressure
Method AddImportedLoadExternalData() (p. 166) Creates a new Import Load (External Data).
Method AddImportedLoadResultFile() (p. 166) Creates a new Import Load (Result File).
Method AddImportedRemoteLoadsGroup() (p. 166) Creates a new Import Remote Load Group.
Method AddInitialVelocity() (p. 167) Creates a new child Initial Velocity.
Method AddInternalHeatGeneration() (p. 167) Creates a new InternalHeatGeneration
Method AddJointLoad() (p. 167) Creates a new JointLoad
Method AddLimitBoundary() (p. 167) Creates a new LimitBoundary
Method AddLinePressure() (p. 167) Creates a new LinePressure
Method AddLocalVonMisesStressConstraint() (p. 167) Creates a new LocalVonMisesStressConstraint
Method AddMagneticFluxParallel() (p. 168) Creates a new MagneticFluxParallel
Method AddMassConstraint() (p. 168) Creates a new MassConstraint
Method AddMassFlowRate() (p. 168) Creates a new MassFlowRate
Method AddMemberSizeManufacturingConstraint() (p. 168) Creates a new MemberSizeManufacturingConstrain
Method AddMoment() (p. 168) Creates a new Moment
Method AddMomentOfInertiaConstraint() (p. 168) Creates a new MomentOfInertiaConstraint
Method AddNaturalFrequencyConstraint() (p. 169) Creates a new NaturalFrequencyConstraint
Method AddNodalDisplacement() (p. 169) Creates a new NodalDisplacement
Method AddNodalForce() (p. 169) Creates a new NodalForce
Method AddNodalOrientation() (p. 169) Creates a new NodalOrientation
Method AddNodalPressure() (p. 169) Creates a new NodalPressure
Method AddNodalRotation() (p. 169) Creates a new NodalRotation
Method AddNonlinearAdaptiveRegion() (p. 170) Creates a new NonlinearAdaptiveRegion

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 149
Ansys.ACT.Automation.Mechanical Namespace

Method AddObjective() (p. 170) Creates a new Objective

Method AddOptimizationRegion() (p. 170) Creates a new OptimizationRegion
Method AddPatternRepetitionConstraint() (p. 170) Creates a new PatternRepetitionConstraint
Method AddPerfectlyInsulated() (p. 170) Creates a new PerfectlyInsulated
Method AddPhysicsRegion() (p. 170) Creates a new PhysicsRegion
Method AddPipeIdealization() (p. 171) Creates a new child PipeIdealization.
Method AddPipePressure() (p. 171) Creates a new PipePressure
Method AddPipeTemperature() (p. 171) Creates a new PipeTemperature
Method AddPlasticHeating() (p. 171) Creates a new PlasticHeating
Method AddPressure() (p. 171) Creates a new child Pressure.
Method AddPSDAcceleration() (p. 171) Creates a new PSDAcceleration
Method AddPSDDisplacement() (p. 172) Creates a new PSDDisplacement
Method AddPSDGAcceleration() (p. 172) Creates a new PSDGAcceleration
Method AddPSDVelocity() (p. 172) Creates a new PSDVelocity
Method AddPullOutDirectionManufacturingConstraint() (p. 172) Creates a new
PullOutDirectionManufacturingConstraint
Method AddPythonCodeEventBased() (p. 172) Creates a new PythonCodeEventBased
Method AddRadiation() (p. 172) Creates a new Radiation
Method AddReactionForceConstraint() (p. 173) Creates a new ReactionForceConstraint
Method AddRemoteDisplacement() (p. 173) Creates a new RemoteDisplacement
Method AddRemoteForce() (p. 173) Creates a new RemoteForce
Method AddRotatingForce() (p. 173) Creates a new RotatingForce
Method AddRotationalAcceleration() (p. 173) Creates a new RotationalAcceleration
Method AddRotationalVelocity() (p. 173) Creates a new RotationalVelocity
Method AddRSAcceleration() (p. 174) Creates a new RSAcceleration
Method AddRSDisplacement() (p. 174) Creates a new RSDisplacement
Method AddRSVelocity() (p. 174) Creates a new RSVelocity
Method AddSimplySupported() (p. 174) Creates a new SimplySupported
Method AddSourceConductor() (p. 174) Creates a new child SourceConductor.
Method AddSubstructureGenerationCondensedPart() (p. 174) Creates a new
SubstructureGenerationCondensedPart
Method AddSurfaceChargeDensity() (p. 175) Creates a new SurfaceChargeDensity
Method AddSymmetryManufacturingConstraint() (p. 175) Creates a new SymmetryManufacturingConstraint
Method AddSystemCouplingRegion() (p. 175) Creates a new SystemCouplingRegion
Method AddTemperature() (p. 175) Creates a new Temperature
Method AddTemperatureConstraint() (p. 175) Creates a new TemperatureConstraint
Method AddThermalComplianceConstraint() (p. 175) Creates a new ThermalComplianceConstraint
Method AddThermalCondition() (p. 176) Creates a new child ThermalCondition.
Method AddUniformConstraint() (p. 176) Creates a new UniformConstraint

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
150 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Method AddVelocity() (p. 176) Creates a new Velocity

Method AddViscoelasticHeating() (p. 176) Creates a new ViscoelasticHeating
Method AddVoltage() (p. 176) Creates a new Voltage
Method AddVoltageCoupling() (p. 176) Creates a new Coupling
Method AddVoltageGround() (p. 177) Creates a new VoltageGround
Method AddVolumeChargeDensity() (p. 177) Creates a new VolumeChargeDensity
Method AddVolumeConstraint() (p. 177) Creates a new VolumeConstraint
Method ClearGeneratedData() (p. 177) Run the ClearGeneratedData action.
Method CreateAutomaticFarFieldRadiationSurfaces() (p. 177) Run the CreateAutomaticEquivalentSourceSurfaces
action.
Method CreateAutomaticFSI() (p. 177) Run the CreateAutomaticFSI action.
Method CreateAutomaticFSIandFarFieldRadiationSurfaces() (p. 178) Run the
CreateAutomaticFSIandEquivalentSourceSurfaces
action.
Method Delete() (p. 178) Run the Delete action.
Method Duplicate() (p. 178) No details are provided for this entry.
Method ExportNastranFile(NastranExportOptions) (p. 178) Export Nastran File.
Method FilterBasedOnEnvironment() (p. 178) 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. 179)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 179)
Method ImportLoad(Analysis) (p. 179) Import Load action.
Method OpenSolverFilesDirectory() (p. 180) Run the OpenSolverFilesDirectory action.
Method SelectBodiesWithMultiplePhysicsRegion() (p. 180) Run the SelectBodiesWithMultiplePhysicsRegion
action to select the bodies that belong to more tha
one Physics Region.
Method SelectBodiesWithoutPhysicsRegion() (p. 180) Run the SelectBodiesWithoutPhysicsRegion action
to select the bodies that don't belong to a Physics
Region.
Method Solve(bool) (p. 180) Run the Solve action.
Method Solve(bool, string) (p. 181) Run the Solve action.
Method TransferDataFrom(Analysis) (p. 181) Transfer Data From action.
Method UnlinkDataFrom(Analysis) (p. 181) Unlink Data From action.
Method WriteSystemCouplingFiles(string) (p. 181) Writes the system coupling files. Usage
WriteSystemCouplingFiles("C:\\Desktop\\temp\\scp

Acoustics
Gets or sets the Acoustics.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 151
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool Acoustics { set;get; }

AMProcessSimulation
Gets or sets the AMProcessSimulation.

Declaration Syntax
public AMProcessSimulationType AMProcessSimulation { set;get; }

AnalysisSettings
Gets the AnalysisSettings.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
152 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Electric
Gets the Electric.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 153
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
154 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public bool Structural { set;get; }

SystemCaption
Gets the SystemCaption.

Declaration Syntax
public string SystemCaption { get; }

Thermal
Gets the Thermal.

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 155
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AcousticDiffuseSoundField AddAcousticDiffuseSoundField()

AddAcousticFarFieldRadationSurface()
Creates a new AcousticFarFieldRadationSurface

Declaration Syntax
public virtual AcousticFarFieldRadationSurface AddAcousticFarFieldRadationSurface()

AddAcousticFreeSurface()
Creates a new AcousticFreeSurface

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
156 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual AcousticLowReducedFrequency AddAcousticLowReducedFrequency()

AddAcousticMassSource()
Creates a new AcousticMassSource

Declaration Syntax
public virtual AcousticMassSource AddAcousticMassSource()

AddAcousticMassSourceRate()
Creates a new AcousticMassSourceRate

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 157
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AcousticRadiationBoundary AddAcousticRadiationBoundary()

AddAcousticRigidWall()
Creates a new AcousticRigidWall

Declaration Syntax
public virtual AcousticRigidWall AddAcousticRigidWall()

AddAcousticStaticPressure()
Creates a new AcousticStaticPressure

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
158 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual AcousticTemperature AddAcousticTemperature()

AddAcousticThermoViscousBLIBoundary()
Creates a new AcousticThermoViscousBLIBoundary

Declaration Syntax
public virtual AcousticThermoViscousBLIBoundary AddAcousticThermoViscousBLIBoundary()

AddAcousticTransferAdmittanceMatrix()
Creates a new AcousticTransferAdmittanceMatrix

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 159
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual BoltPretension AddBoltPretension()

AddCenterOfGravityConstraint()
Creates a new CenterOfGravityConstraint

Declaration Syntax
public virtual CenterOfGravityConstraint AddCenterOfGravityConstraint()

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
160 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual ConstraintEquation AddConstraintEquation()

AddContactStepControl()
Creates a new ContactStepControl

Declaration Syntax
public virtual ContactStepControl AddContactStepControl()

AddConvection()
Creates a new Convection

Declaration Syntax
public virtual Convection AddConvection()

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()

AddCyclicManufacturingConstraint()
Creates a new CyclicManufacturingConstraint

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 161
Ansys.ACT.Automation.Mechanical Namespace

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()

AddEarthGravity()
Creates a new EarthGravity

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
162 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

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()

AddFigure()
Creates a new child Figure.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 163
Ansys.ACT.Automation.Mechanical Namespace

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()

AddFluidSolidInterface()
Creates a new FluidSolidInterface

Declaration Syntax
public virtual FluidSolidInterface AddFluidSolidInterface()

AddForce()
Creates a new Force

Declaration Syntax
public virtual Force AddForce()

AddFrictionlessSupport()
Creates a new FrictionlessSupport

Declaration Syntax
public virtual FrictionlessSupport AddFrictionlessSupport()

AddGeneralizedPlaneStrain()
Creates a new GeneralizedPlaneStrain

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
164 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual GeneralizedPlaneStrain AddGeneralizedPlaneStrain()

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

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 165
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual ImportedCFDPressure AddImportedCFDPressure()

AddImportedLoadExternalData()
Creates a new Import Load (External Data).

Declaration Syntax
public virtual ImportedLoadGroup AddImportedLoadExternalData()

AddImportedLoadResultFile()
Creates a new Import Load (Result File).

Declaration Syntax
public virtual ImportedLoadGroup AddImportedLoadResultFile()

AddImportedRemoteLoadsGroup()
Creates a new Import Remote Load Group.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
166 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual LoadGroup AddImportedRemoteLoadsGroup()

AddInitialVelocity()
Creates a new child Initial Velocity.

Declaration Syntax
public virtual InitialCondition AddInitialVelocity()

AddInternalHeatGeneration()
Creates a new InternalHeatGeneration

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 167
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual LocalVonMisesStressConstraint AddLocalVonMisesStressConstraint()

AddMagneticFluxParallel()
Creates a new MagneticFluxParallel

Declaration Syntax
public virtual MagneticFluxParallel AddMagneticFluxParallel()

AddMassConstraint()
Creates a new MassConstraint

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
168 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual MomentOfInertiaConstraint AddMomentOfInertiaConstraint()

AddNaturalFrequencyConstraint()
Creates a new NaturalFrequencyConstraint

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 169
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual NodalRotation AddNodalRotation()

AddNonlinearAdaptiveRegion()
Creates a new NonlinearAdaptiveRegion

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
170 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual PhysicsRegion AddPhysicsRegion()

AddPipeIdealization()
Creates a new child PipeIdealization.

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()
Creates a new child Pressure.

Declaration Syntax
public virtual Pressure AddPressure()

AddPSDAcceleration()
Creates a new PSDAcceleration

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 171
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
172 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 173
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
174 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()
Creates a new Temperature

Declaration Syntax
public virtual Temperature AddTemperature()

AddTemperatureConstraint()
Creates a new TemperatureConstraint

Declaration Syntax
public virtual TemperatureConstraint AddTemperatureConstraint()

AddThermalComplianceConstraint()
Creates a new ThermalComplianceConstraint

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 175
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual ThermalComplianceConstraint AddThermalComplianceConstraint()

AddThermalCondition()
Creates a new child ThermalCondition.

Declaration Syntax
public virtual ThermalCondition AddThermalCondition()

AddUniformConstraint()
Creates a new UniformConstraint

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
176 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

Declaration Syntax
public virtual Coupling AddVoltageCoupling()

AddVoltageGround()
Creates a new VoltageGround

Declaration Syntax
public virtual VoltageGround AddVoltageGround()

AddVolumeChargeDensity()
Creates a new VolumeChargeDensity

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 177
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void CreateAutomaticFSI()

CreateAutomaticFSIandFarFieldRadiationSurfaces()
Run the CreateAutomaticFSIandEquivalentSourceSurfaces action.

Declaration Syntax
public virtual void CreateAutomaticFSIandFarFieldRadiationSurfaces()

Delete()
Run the Delete action.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
178 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 179
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void ImportLoad(Analysis analysis)

Parameters
analysis(Analysis)

Analysis system.

OpenSolverFilesDirectory()
Run the OpenSolverFilesDirectory action.

Declaration Syntax
public virtual void OpenSolverFilesDirectory()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
180 of ANSYS, Inc. and its subsidiaries and affiliates.
 Analysis

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. 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");

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 181
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void WriteSystemCouplingFiles(string filename)

Parameters
filename(string)

No details are provided for this entry.

AnalysisPly
Defines a AnalysisPly.

Declaration Syntax
public class AnalysisPly : ImportedDataModelObject, IFolderDataModelObject

Table 97: Members

Property Angle (p. 183) Gets or sets the Angle.

Property Children (p. 183) Gets the list of children.
Property Comments (p. 183) Gets the list of associated comments.
Property DataModelObjectCategory (p. 183) Gets the current DataModelObject's category.
Property Figures (p. 183) Gets the list of associated figures.
Property IDInSource (p. 183) Gets the IDInSource.
Property Images (p. 184) Gets the list of associated images.
Property InternalObject (p. 184) Gets the internal object. For advanced usage only.
Property Material (p. 184) Gets the Material.
Property NameInSource (p. 184) Gets the NameInSource.
Property NumberOfElements (p. 184) Gets the NumberOfElements.
Property Thickness (p. 184) Gets the Thickness.
Method AddComment() (p. 185) Creates a new child Comment.
Method AddFigure() (p. 185) Creates a new child Figure.
Method AddImage(string) (p. 185) 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. 185)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 186)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
182 of ANSYS, Inc. and its subsidiaries and affiliates.
 AnalysisPly

Angle
Gets or sets the Angle.

Declaration Syntax
public Quantity Angle { 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; }

IDInSource
Gets the IDInSource.

Declaration Syntax
public string IDInSource { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 183
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 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
184 of ANSYS, Inc. and its subsidiaries and affiliates.
 AnalysisPly

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 185
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.)

ArbitraryCrack
Defines a ArbitraryCrack.

Declaration Syntax
public class ArbitraryCrack : GenericCrack

Table 98: Members

Property BottomFaceNodes (p. 187) Gets or sets the BottomFaceNodes.

Property Children (p. 418) Gets the list of children.

(Inherited from GenericCrack (p. 417).)

Property CircumferentialDivisions (p. 187) Gets or sets the CircumferentialDivisions.
Property Comments (p. 418) Gets the list of associated comments.

(Inherited from GenericCrack (p. 417).)

Property CoordinateSystem (p. 188) Gets or sets the CoordinateSystem.
Property CrackFacesNodes (p. 188) Gets or sets the CrackFacesNodes.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
186 of ANSYS, Inc. and its subsidiaries and affiliates.

Property CrackFrontNodes (p. 188)
Property CrackMeshMethod (p. 188)
Property CrackShape (p. 188)
Property CrackSourceType (p. 188)
Property CrackSurfaceLocation (p. 189)
Property DataModelObjectCategory (p. 189) Gets the current DataModelObject's
category.
Property Figures (p. 418)
Property FrontElementSize (p. 189)
Property GrowthRate (p. 189)
Property Images (p. 418)
Property InternalObject (p. 189)
Property LargestContourRadius (p. 189)
Property Location (p. 190)
Property MeshContours (p. 190)
Property SolutionContours (p. 190)
Property Suppressed (p. 190)
Property TopFaceNodes (p. 190)
Property XScaleFactor (p. 190)
Property YScaleFactor (p. 191)
Property ZScaleFactor (p. 191)
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; }
Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates.
ArbitraryCrack
Gets or sets the CrackFrontNodes.
Gets the CrackMeshMethod.
Gets the CrackShape.
Gets the CrackSourceType.
Gets or sets the CrackSurfaceLocation.
Gets the list of associated figures.
(Inherited from GenericCrack (p. 417).)
Gets or sets the FrontElementSize.
Gets or sets the GrowthRate.
Gets the list of associated images.
(Inherited from GenericCrack (p. 417).)
Gets the internal object. For advanced usage
only.
Gets or sets the LargestContourRadius.
Gets or sets the Location.
Gets or sets the MeshContours.
Gets or sets the SolutionContours.
Gets or sets the Suppressed.
Gets or sets the TopFaceNodes.
Gets or sets the XScaleFactor.
Gets or sets the YScaleFactor.
Gets or sets the ZScaleFactor.
187
Ansys.ACT.Automation.Mechanical Namespace

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; }

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
188 of ANSYS, Inc. and its subsidiaries and affiliates.
 ArbitraryCrack

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; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Declaration Syntax
public Quantity LargestContourRadius { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 189
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
190 of ANSYS, Inc. and its subsidiaries and affiliates.
 BatchConnectionsWorksheet

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; }

BatchConnectionsWorksheet
No details are provided for this entry.

Declaration Syntax
public class BatchConnectionsWorksheet : Worksheet

Table 99: Members

Property RowCount (p. 192) Gets the number of entries

Method AddRow() (p. 192) Add a row to the MeshControlWorksheet
Method ClearGenerateMesh() (p. 192) Clear Mesh
Method DeleteAllRows() (p. 192) Delete All Rows
Method DeleteRow(int) (p. 192) Delete a row from the MeshControlWorksheet
Method GenerateAtRow(int) (p. 193) Generate Mesh At Row
Method GenerateMesh() (p. 193) Geneate Mesh
Method GetActiveState(int) (p. 193) Gets the Active State property at row index
Method GetConnectionOption(int) (p. 193) Gets the current set cconnection option at
the row index
Method GetConnectionTolerances(int) (p. 194) Gets the list of connection tolerances at the
row index
Method GetNamedSelection(int) (p. 194) Gets the NamedSelection at row index
Method GetNamedSelectionId(int) (p. 194) Gets the ID of the NamedSelection at row
index
Method SetActiveState(int, bool) (p. 195) Sets the Active State property at row index
Method SetConnectionOption(int, int) (p. 195) Sets the connection option at row index
Method SetConnectionTolerances(int, string) (p. 195) Sets the connection tolerance list at row
index

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 191
Ansys.ACT.Automation.Mechanical Namespace

Method SetNamedSelection(int, Sets the NamedSelection at row index

NamedSelection) (p. 196)
Method SetNamedSelectionId(int, uint) (p. 196) 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()

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
192 of ANSYS, Inc. and its subsidiaries and affiliates.
 BatchConnectionsWorksheet

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

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 193
Ansys.ACT.Automation.Mechanical Namespace

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
194 of ANSYS, Inc. and its subsidiaries and affiliates.
 BatchConnectionsWorksheet

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 195
Ansys.ACT.Automation.Mechanical Namespace

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

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
196 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

Declaration Syntax
public class Body : ImportedDataModelObject, IFolderDataModelObject

Table 100: Members

Property Assignment ***OBSOLETE*** Use Gets or sets the Assignment.

'Material' property instead. (p. 199)
Property Average (p. 199) Gets the Average.
Property BeamSection (p. 200) Gets the BeamSection.
Property Behavior (p. 200) Gets or sets the Behavior.
Property BrickIntegrationScheme (p. 200) Gets or sets the BrickIntegrationScheme.
Property CentroidX (p. 200) Gets the CentroidX.
Property CentroidY (p. 200) Gets the CentroidY.
Property CentroidZ (p. 200) Gets the CentroidZ.
Property Children (p. 201) Gets the list of children.
Property Comments (p. 201) Gets the list of associated comments.
Property ConfigurationId (p. 201) Gets the related Result Mesh's ConfigurationId.
Property CoordinateSystem (p. 201) Gets or sets the CoordinateSystem.
Property CrossSectionArea (p. 201) Gets the CrossSectionArea.
Property CrossSectionIYY (p. 201) Gets the CrossSectionIYY.
Property CrossSectionIZZ (p. 202) Gets the CrossSectionIZZ.
Property CrossSectionName (p. 202) Gets CrossSectionName.
Property CrossSectionSelection (p. 202) Gets or sets the CrossSectionSelection.
Property DataModelObjectCategory (p. 202) Gets the current DataModelObject's category.
Property Dimension (p. 202) Gets or sets the Dimension.
Property Elements (p. 202) Gets the Elements.
Property FiberAngle (p. 203) Gets or sets the FiberAngle.
Property FiberCrossSectionArea (p. 203) Gets or sets the FiberCrossSectionArea.
Property FiberSpacing (p. 203) Gets or sets the FiberSpacing.
Property Figures (p. 203) Gets the list of associated figures.
Property FluidCrossArea (p. 203) Gets or sets the FluidCrossArea.
Property FluidDiscretization (p. 203) Gets or sets the FluidDiscretization.
Property FluidSolidPhase (p. 204) Gets or sets the FluidSolidPhase.
Property GeometryType (p. 204) Gets the GeometryType.
Property Hidden (p. 204) Hide or show the body.
Property HomogeneousMembrane (p. 204) Gets or sets the HomogeneousMembrane.
Property Images (p. 204) Gets the list of associated images.
Property InternalObject (p. 204) Gets the internal object. For advanced usage only.
Property IsWindingBody (p. 205) Gets the IsWindingBody.
Property Length (p. 205) Gets the Length.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 197
Ansys.ACT.Automation.Mechanical Namespace

Property LengthX (p. 205) Gets the LengthX.

Property LengthY (p. 205) Gets the LengthY.
Property LengthZ (p. 205) Gets the LengthZ.
Property LinkTrussBehavior (p. 205) Gets or sets the LinkTrussBehavior.
Property ManualThicknessMode (p. 206) Gets the ManualThicknessMode.
Property Mass (p. 206) Gets the Mass.
Property Material (p. 206) Gets or sets the Material.
Property Maximum (p. 206) Gets the Maximum.
Property MeshMetric (p. 206) Gets the MeshMetric.
Property MeshVersion (p. 206) Gets the MeshVersion.
Property Minimum (p. 207) Gets the Minimum.
Property ModelType (p. 207) Gets or sets the ModelType. Note: ModelType is
applicable to line bodies and surface bodies only.
Property MomentOfInertiaIp1 (p. 207) Gets the MomentOfInertiaIp1.
Property MomentOfInertiaIp2 (p. 207) Gets the MomentOfInertiaIp2.
Property MomentOfInertiaIp3 (p. 207) Gets the MomentOfInertiaIp3.
Property Nodes (p. 207) Gets the Nodes.
Property NonlinearEffects (p. 208) Gets or sets the NonlinearEffects.
Property NumberOfTurns (p. 208) Gets or sets the NumberOfTurns.
Property OffsetMode (p. 208) Gets or sets the OffsetMode.
Property OffsetType (p. 208) Gets or sets the OffsetType.
Property OffsetX (p. 208) Gets or sets the OffsetX.
Property OffsetY (p. 208) Gets or sets the OffsetY.
Property PipeExternalDiameter (p. 209) Gets the PipeExternalDiameter.
Property PipeInternalDiameter (p. 209) Gets the PipeInternalDiameter.
Property PipeThickness (p. 209) Gets the PipeThickness.
Property ReferenceFrame (p. 209) Gets or sets the ReferenceFrame.
Property ReferenceTemperature ***OBSOLETE*** Gets or sets the ReferenceTemperature.
Use 'UseReferenceTemperatureByBody'
property instead. (p. 209)
Property ReferenceTemperatureValue (p. 209) Gets or sets the ReferenceTemperatureValue.
Property ReinforcingStressState (p. 210) Gets or sets the ReinforcingStressState.
Property ResultMeshId (p. 210) Gets the related Result Mesh's ObjectId.
Property ShellOffsetType (p. 210) Gets or sets the ShellOffsetType.
Property StandardDeviation (p. 210) Gets the StandardDeviation.
Property StiffnessBehavior (p. 210) Gets or sets the StiffnessBehavior.
Property StiffnessOption (p. 210) Gets or sets the StiffnessOption.
Property Suppressed (p. 211) Gets or sets the Suppressed.
Property SuppressedParameterized (p. 211) Gets if the part suppressed property is
parameterized.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
198 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

Property SurfaceArea (p. 211) Gets the SurfaceArea.

Property ThermalStrainEffects (p. 211) Gets or sets the ThermalStrainEffects.
Property Thickness (p. 211) Gets or sets the Thickness.
Property ThicknessMode ***OBSOLETE*** Use Gets the ThicknessMode.
'ManualThicknessMode' property
instead. (p. 211)
Property Treatment (p. 212) Gets or sets the Treatment.
Property UseReferenceTemperatureByBody (p. 212) Gets or sets the UseReferenceTemperatureByBody.
Property UserNameChange (p. 212) Gets the UserNameChange.
Property Visible (p. 212) Gets or sets the Visible.
Property Volume (p. 212) Gets the Volume.
Method AddCommandSnippet() (p. 212) Creates a new CommandSnippet
Method AddComment() (p. 213) Creates a new child Comment.
Method AddFigure() (p. 213) Creates a new child Figure.
Method AddImage(string) (p. 213) 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. 213) Creates a new PythonCodeEventBased
Method ClearGeneratedData() (p. 213) Run the ClearGeneratedData action.
Method GenerateMesh() (p. 214) Run the GenerateMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 214)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 214)
Method GetGeoBody() (p. 215) Gets the Geo Body
Method PreviewInflation() (p. 215) Run the PreviewInflation action.
Method PreviewSurfaceMesh() (p. 215) Run the PreviewSurfaceMesh action.
Method ShowBody() (p. 215) Run the ShowBody action.
Method Update() (p. 215) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 199
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
200 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

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; }

CrossSectionArea
Gets the CrossSectionArea.

Declaration Syntax
public Quantity CrossSectionArea { get; }

CrossSectionIYY
Gets the CrossSectionIYY.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 201
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity CrossSectionIYY { get; }

CrossSectionIZZ
Gets the CrossSectionIZZ.

Declaration Syntax
public Quantity CrossSectionIZZ { get; }

CrossSectionName
Gets CrossSectionName.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
202 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 203
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public FluidDiscretizationType FluidDiscretization { set;get; }

FluidSolidPhase
Gets or sets the FluidSolidPhase.

Declaration Syntax
public PhaseType FluidSolidPhase { set;get; }

GeometryType
Gets the GeometryType.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
204 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

Declaration Syntax
public IDSPrototypeAuto InternalObject { get; }

IsWindingBody
Gets the IsWindingBody.

Declaration Syntax
public bool IsWindingBody { get; }

Length
Gets the Length.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 205
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public PrototypeLinkBehavior LinkTrussBehavior { set;get; }

ManualThicknessMode
Gets the ManualThicknessMode.

Declaration Syntax
public bool ManualThicknessMode { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
206 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

Declaration Syntax
public int MeshVersion { get; }

Minimum
Gets the Minimum.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 207
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int Nodes { get; }

NonlinearEffects
Gets or sets the NonlinearEffects.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
208 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

Declaration Syntax
public Quantity OffsetY { set;get; }

PipeExternalDiameter
Gets the PipeExternalDiameter.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 209
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity ReferenceTemperatureValue { set;get; }

ReinforcingStressState
Gets or sets the ReinforcingStressState.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
210 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

Declaration Syntax
public ShellElementStiffnessOption StiffnessOption { set;get; }

Suppressed
Gets or sets the Suppressed.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 211
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool ThicknessMode { 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
212 of ANSYS, Inc. and its subsidiaries and affiliates.
 Body

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 213
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
214 of ANSYS, Inc. and its subsidiaries and affiliates.
 CenterOfGravityConstraint

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 215
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CenterOfGravityConstraint : ResponseConstraint

Table 101: Members

Property Axis (p. 216) Gets or sets the Axis.

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 216)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 216)
Property Location (p. 217)
Property MaximumPosition (p. 217)
Property MinimumPosition (p. 217)
Property ScopingMethod (p. 217)
Property Selection (p. 217)
Property Suppressed (p. 810)
Gets the internal object. For advanced usage only.
Gets or sets the Location.
Gets or sets the MaximumPosition.
Gets or sets the MinimumPosition.
Gets or sets the ScopingMethod.
Gets or sets the Selection.
Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
216 of ANSYS, Inc. and its subsidiaries and affiliates.
 ChannelCrossSection

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 217
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class ChannelCrossSection : CrossSection

Table 102: Members

Property Area (p. 218) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 218)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 219) Gets the internal object. For advanced usage
only.
Property IYY (p. 219) Gets the IYY.
Property IZZ (p. 219) Gets the IZZ.
Property Thick1 (p. 219) Gets or sets the Thick1.
Property Thick2 (p. 219) Gets or sets the Thick2.
Property Thick3 (p. 219) Gets or sets the Thick3.
Property Width1 (p. 220) Gets or sets the Width1.
Property Width2 (p. 220) Gets or sets the Width2.
Property Width3 (p. 220) Gets or sets the Width3.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
218 of ANSYS, Inc. and its subsidiaries and affiliates.
 ChannelCrossSection

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 219
Ansys.ACT.Automation.Mechanical Namespace

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 103: Members

Property Caption (p. 221) Gets or sets the Caption.

Property Children (p. 221) Gets the list of children.
Property Comments (p. 221) Gets the list of associated comments.
Property Content (p. 221) Gets or sets the Content.
Property DataModelObjectCategory (p. 222) Gets the current DataModelObject's category.
Property Gridlines (p. 222) Gets or sets the Gridlines.
Property Images (p. 222) Gets the list of associated images.
Property InternalObject (p. 222) Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
220 of ANSYS, Inc. and its subsidiaries and affiliates.
 Chart

Property ModalDisplayType (p. 222) Gets or sets the ModalDisplayType.

Property OutlineSelection (p. 222) Gets or sets the OutlineSelection.
Property PlotStyle (p. 223) Gets or sets the PlotStyle.
Property Scale (p. 223) Gets or sets the Scale.
Property XAxis (p. 223) Use to control the X Axis property of the chart.
Property XAxisLabel (p. 223) Gets or sets the XAxisLabel.
Property YAxisLabel (p. 223) Gets or sets the YAxisLabel.
Method AddComment() (p. 223) Creates a new child Comment.
Method AddImage(string) (p. 224) 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. 224) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 224)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 225)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 221
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
222 of ANSYS, Inc. and its subsidiaries and affiliates.
 Chart

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 223
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
224 of ANSYS, Inc. and its subsidiaries and affiliates.
 ChartXAxis

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 104: Members

Property ComponentIndex (p. 225) Gets or sets the component index for the chart.
Property ObjectSelection (p. 226) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 225
Ansys.ACT.Automation.Mechanical Namespace

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 105: Members

Property Area (p. 226) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 227)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 227) Gets the internal object. For advanced usage
only.
Property IYY (p. 227) Gets the IYY.
Property IZZ (p. 227) Gets the IZZ.
Property Radius (p. 227) Gets or sets the Radius.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
226 of ANSYS, Inc. and its subsidiaries and affiliates.
 CircularTubeCrossSection

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 227
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class CircularTubeCrossSection : CrossSection

Table 106: Members

Property Area (p. 228) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 228)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InnerRadius (p. 228) Gets or sets the InnerRadius.
Property InternalObject (p. 229) Gets the internal object. For advanced usage
only.
Property IYY (p. 229) Gets the IYY.
Property IZZ (p. 229) Gets the IZZ.
Property OuterRadius (p. 229) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
228 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandSnippet

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 107: Members

Property Children (p. 231) Gets the list of children.

Property Comments (p. 231) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 229
Ansys.ACT.Automation.Mechanical Namespace

Property DataModelObjectCategory (p. 231) Gets the current DataModelObject's category.

Property Figures (p. 231) Gets the list of associated figures.
Property FileName (p. 231) Gets the FileName.
Property Images (p. 231) Gets the list of associated images.
Property Input (p. 232) Gets or sets the Text.
Property InputArgument1 (p. 232) Gets or sets the InputArgument1.
Property InputArgument2 (p. 232) Gets or sets the InputArgument2.
Property InputArgument3 (p. 232) Gets or sets the InputArgument3.
Property InputArgument4 (p. 232) Gets or sets the InputArgument4.
Property InputArgument5 (p. 232) Gets or sets the InputArgument5.
Property InputArgument6 (p. 233) Gets or sets the InputArgument6.
Property InputArgument7 (p. 233) Gets or sets the InputArgument7.
Property InputArgument8 (p. 233) Gets or sets the InputArgument8.
Property InputArgument9 (p. 233) Gets or sets the InputArgument9.
Property InternalObject (p. 233) Gets the internal object. For advanced usage only.
Property InvalidateSolution (p. 233) Gets or sets the InvalidateSolution.
Property IssueSolveCommand (p. 234) Gets or sets the IssueSolveCommand.
Property OutputParameters (p. 234) Gets a list of the command snippet's output
parameters.
Property OutputSearchPrefix (p. 234) Gets or sets the OutputSearchPrefix.
Property SnippetFileStatus (p. 234) Gets the SnippetFileStatus.
Property SolverTarget (p. 234) Gets the SolverTarget.
Property StepNumber (p. 234) Gets or sets the StepNumber.
Property StepSelectionMode (p. 235) Gets or sets the StepSelectionMode.
Property Suppressed (p. 235) Gets or sets the Suppressed.
Method AddComment() (p. 235) Creates a new child Comment.
Method AddFigure() (p. 235) Creates a new child Figure.
Method AddImage(string) (p. 235) 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. 236) Append Text.
Method Delete() (p. 236) Run the Delete action.
Method ExportTextFile(string) (p. 236) Export to Textfile.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 236)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 237)
Method ImportTextFile(string) (p. 237) Import from Textfile.
Method RenameBasedOnDefinition() (p. 238) Run the RenameBasedOnDefinition action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
230 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandSnippet

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 231
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
232 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandSnippet

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 233
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
234 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandSnippet

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 235
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
236 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandSnippet

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 237
Ansys.ACT.Automation.Mechanical Namespace

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Comment
Defines a Comment.

Declaration Syntax
public class Comment : DataModelObject, IFolderDataModelObject

Table 108: Members

Property Author (p. 238) Gets or sets the Author.

Property Children (p. 238) Gets the list of children.
Property DataModelObjectCategory (p. 239) Gets the current DataModelObject's
category.
Property InternalObject (p. 239) Gets the internal object. For advanced
usage only.
Property Text (p. 239) Gets the Text.
Method Delete() (p. 239) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 239)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 240)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
238 of ANSYS, Inc. and its subsidiaries and affiliates.
 Comment

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 239
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.)

ComplianceConstraint
Defines a ComplianceConstraint.

Declaration Syntax
public class ComplianceConstraint : ResponseConstraint

Table 109: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property ComplianceLimit (p. 241) Gets or sets the ComplianceLimit.
Property DataModelObjectCategory (p. 241)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 241) Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
240 of ANSYS, Inc. and its subsidiaries and affiliates.
 CompositeCriterion

Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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 110: Members

Property Children (p. 318) Gets the list of children.

(Inherited from Criterion (p. 317).)

Property Comments (p. 318) Gets the list of associated comments.

(Inherited from Criterion (p. 317).)

Property DataModelObjectCategory (p. 242)Gets the current DataModelObject's category.
Property Figures (p. 318) Gets the list of associated figures.

(Inherited from Criterion (p. 317).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 241
Ansys.ACT.Automation.Mechanical Namespace

Property Images (p. 318) Gets the list of associated images.

(Inherited from Criterion (p. 317).)

Property InternalObject (p. 242) Gets the internal object. For advanced usage only.
Property Suppressed (p. 319) Gets or sets the Suppressed.

(Inherited from Criterion (p. 317).)

Property Value (p. 242)
Method ClearGeneratedData() (p. 242)
Method EvaluateAllResults() (p. 243)
Method GetDefinition() (p. 243)
Gets the Value.
Run the ClearGeneratedData action.
Run the EvaluateAllResults action.
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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
242 of ANSYS, Inc. and its subsidiaries and affiliates.
 CompositeCriterionDefinition

EvaluateAllResults()
Run the EvaluateAllResults action.

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 111: Members

Property Count (p. 243) Gives the number of CompositeCriterionTerms in the definition.
Property Item (p. 244) No details are provided for this entry.
Method Add(CompositeCriterionTerm) (p. 244) Adds a CompositeCriterionTerm at the end in the definition. Usage:
CriterionDefinition.Add(Ansys.ACT.Automation.Mechanical.Composit
1.3))
Method Clear() (p. 244) Clears all the CompositeCriterionTerms in the definition.
Method IndexOf(CompositeCriterionTerm) (p. 244) 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. 245) IndexOutOfRangeException for invalid index. Usage: CriterionDefinit
Ansys.ACT.Automation.Mechanical.CompositeCriterionTerm(primCrit
Method RemoveAt(int) (p. 245) Removes the CompositeCriterionTerm at a specified index in the de
IndexOutOfRangeException for invalid index.

Count
Gives the number of CompositeCriterionTerms in the definition.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 243
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public int Count { get; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
244 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 112: Members

Constructor CompositeCriterionTerm() (p. 246) Creates and returns a new

CompositeCriterionTerm.
Constructor CompositeCriterionTerm(PrimaryCriterion, Returns a new CompositeCriterionTerm with
double) (p. 246) given inputs

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 245
Ansys.ACT.Automation.Mechanical Namespace

Property Coefficient (p. 246) Returns coefficient of PrimaryCriterion in the

CompositeCriterionTerm.
Property PrimaryCriterion (p. 246) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
246 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedGeometry

CondensedGeometry
Defines a CondensedGeometry.

Declaration Syntax
public class CondensedGeometry : DataModelObject, IFolderDataModelObject

Table 113: Members

Property Children (p. 247) Gets the list of children.

Property Comments (p. 248) Gets the list of associated comments.
Property DataModelObjectCategory (p. 248) Gets the current DataModelObject's category.
Property Figures (p. 248) Gets the list of associated figures.
Property Images (p. 248) Gets the list of associated images.
Property InternalObject (p. 248) Gets the internal object. For advanced usage
only.
Property SolverFilesDirectory (p. 248) Gets the SolverFilesDirectory.
Property TransparencyEnabled (p. 249) Gets or sets the TransparencyEnabled.
Method AddComment() (p. 249) Creates a new child Comment.
Method AddCondensedPart() (p. 249) Creates a new CondensedPart
Method AddCondensedPartInfoTool() (p. 249) Creates a new CondensedPartInfoTool
Method AddFigure() (p. 249) Creates a new child Figure.
Method AddImage(string) (p. 249) 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. 250) Creates a new ImportedCondensedPart
Method ClearGeneratedData() (p. 250) Run the ClearGeneratedData action.
Method CreateAutomaticCondensedParts() (p. 250) Run the CreateAutomaticCondensedParts action.
Method Delete() (p. 250) Run the Delete action.
Method GenerateCondensedParts() (p. 250) Run the GenerateCondensedParts action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 251)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 251)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 247
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
248 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 249
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
250 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 2022 R2 - © 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 class CondensedPart : CondensedPartBase
Table 114: Members
Property AttachmentMethod (p. 253)
Property Children (p. 258)
Property Comments (p. 258)
Property DataModelObjectCategory (p. 253)
Property Figures (p. 258)
Property FutureExpansion (p. 254)
Property FutureIntent (p. 254)
Property GenerateDampingMatrix (p. 254)
Property GeometrySelection (p. 259)
Property Images (p. 259)
Property InterfaceMethod (p. 254)
Property Interfaces (p. 254)
Property InternalObject (p. 254)
Property KeepFilesFor (p. 255)
Property LumpedMassFormulation (p. 255)
Property MaximumFrequency (p. 255)
Property MinimumFrequency (p. 255)
Property NumberInterfaceEntries (p. 259)
Property NumberMasterNodes (p. 259)
Property NumberOfModes (p. 255)
Property Physics (p. 259)
Property PointMassTreatment (p. 255)
Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
252
Gets or sets the AttachmentMethod.
Gets the list of children.
(Inherited from CondensedPartBase (p. 257).)
Gets the list of associated comments.
(Inherited from CondensedPartBase (p. 257).)
Gets the current DataModelObject's
category.
Gets the list of associated figures.
(Inherited from CondensedPartBase (p. 257).)
Gets or sets the FutureExpansion.
Gets or sets the FutureIntent.
Gets or sets the GenerateDampingMatrix.
Gets or sets the GeometrySelection.
(Inherited from CondensedPartBase (p. 257).)
Gets the list of associated images.
(Inherited from CondensedPartBase (p. 257).)
Gets or sets the InterfaceMethod.
Returns the Interfaces of the condensed part
Gets the internal object. For advanced usage
only.
Gets or sets the KeepFilesFor.
Gets or sets the LumpedMassFormulation.
Gets or sets the MaximumFrequency.
Gets or sets the MinimumFrequency.
Gets the NumberInterfaceEntries.
(Inherited from CondensedPartBase (p. 257).)
Gets the NumberMasterNodes.
(Inherited from CondensedPartBase (p. 257).)
Gets or sets the NumberOfModes.
Gets the Physics.
(Inherited from CondensedPartBase (p. 257).)
Gets or sets the PointMassTreatment.
of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPart

Property RangeSearch (p. 256) Gets or sets the RangeSearch.

Property ReductionMethod (p. 256) Gets or sets the ReductionMethod.
Property ReferenceTemperature (p. 260) Gets or sets the ReferenceTemperature.

(Inherited from CondensedPartBase (p. 257).)

Property SolutionName (p. 260) Gets or sets the SolutionName.

(Inherited from CondensedPartBase (p. 257).)

Property SolutionNameMode (p. 260) Gets or sets the SolutionNameMode.

(Inherited from CondensedPartBase (p. 257).)

Property SolverFilesDirectory (p. 260) Gets the SolverFilesDirectory.

(Inherited from CondensedPartBase (p. 257).)

Property SolverType (p. 256) Gets or sets the SolverType.
Property SolverUnits (p. 260) Gets or sets the SolverUnits.

(Inherited from CondensedPartBase (p. 257).)

Property SolverUnitSystem (p. 260) Gets or sets the SolverUnitSystem.

(Inherited from CondensedPartBase (p. 257).)

Property StoreBasisResults (p. 256) Gets or sets the StoreBasisResults.
Property Suppressed (p. 261) Gets or sets the Suppressed.

(Inherited from CondensedPartBase (p. 257).)

Property TemperatureUnits (p. 261) Gets the TemperatureUnits.

(Inherited from CondensedPartBase (p. 257).)

Method DetectCondensedPartInterface() (p. 256) Run the DetectCondensedPartInterface
action.
Method ExportCondensedPart(string) (p. 256) Run the Export Condensed Part action.
Method GenerateCondensedParts() (p. 257) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
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
Gets or sets the FutureIntent.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
254 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
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()

ExportCondensedPart(string)
Run the Export Condensed Part action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPartBase

Declaration Syntax
public virtual void ExportCondensedPart(string exportFileName)

Parameters
exportFileName(string)

No details are provided for this entry.

GenerateCondensedParts()
Run the GenerateCondensedParts action.

Declaration Syntax
public virtual void GenerateCondensedParts()

CondensedPartBase
Defines a CondensedPartBase.

Declaration Syntax
public class CondensedPartBase : DataModelObject, IFolderDataModelObject

Table 115: Members

Property Children (p. 258) Gets the list of children.

Property Comments (p. 258) Gets the list of associated comments.
Property DataModelObjectCategory (p. 258) Gets the current DataModelObject's category.
Property Figures (p. 258) Gets the list of associated figures.
Property GeometrySelection (p. 259) Gets or sets the GeometrySelection.
Property Images (p. 259) Gets the list of associated images.
Property InternalObject (p. 259) Gets the internal object. For advanced usage only.
Property NumberInterfaceEntries (p. 259) Gets the NumberInterfaceEntries.
Property NumberMasterNodes (p. 259) Gets the NumberMasterNodes.
Property Physics (p. 259) Gets the Physics.
Property ReferenceTemperature (p. 260) Gets or sets the ReferenceTemperature.
Property SolutionName (p. 260) Gets or sets the SolutionName.
Property SolutionNameMode (p. 260) Gets or sets the SolutionNameMode.
Property SolverFilesDirectory (p. 260) Gets the SolverFilesDirectory.
Property SolverUnits (p. 260) Gets or sets the SolverUnits.
Property SolverUnitSystem (p. 260) Gets or sets the SolverUnitSystem.
Property Suppressed (p. 261) Gets or sets the Suppressed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
Ansys.ACT.Automation.Mechanical Namespace

Property TemperatureUnits (p. 261) Gets the TemperatureUnits.

Method AddCommandSnippet() (p. 261) Creates a new CommandSnippet
Method AddComment() (p. 261) Creates a new child Comment.
Method AddFigure() (p. 261) Creates a new child Figure.
Method AddImage(string) (p. 261) 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. 262) Run the ClearGeneratedData action.
Method Delete() (p. 262) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 262)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 262)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPartBase

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.

Declaration Syntax
public int NumberMasterNodes { get; }

Physics
Gets the Physics.

Declaration Syntax
public CondensedPartPhysics Physics { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public SolverUnitsControlType SolverUnits { set;get; }

SolverUnitSystem
Gets or sets the SolverUnitSystem.

Declaration Syntax
public WBUnitSystemType SolverUnitSystem { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPartBase

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
Ansys.ACT.Automation.Mechanical Namespace

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPartExpansionState

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 116: Members

Constructor CondensedPartExpansionState() (p. 263) Expansion State object.

Property Displacement (p. 263) Gets or sets the Displacement
Property
Property Stress (p. 264) Gets or sets the Stress Property

CondensedPartExpansionState()
Expansion State object.

Declaration Syntax
public CondensedPartExpansionState()

Displacement
Gets or sets the Displacement Property

Release 2022 R2 - © 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 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 117: Members

Property Children (p. 264) Gets the list of children.

Property Comments (p. 265) Gets the list of associated comments.
Property DataModelObjectCategory (p. 265) Gets the current DataModelObject's category.
Property Images (p. 265) Gets the list of associated images.
Property InternalObject (p. 265) Gets the internal object. For advanced usage only.
Property Text (p. 265) Gets the Text.
Property UpdateInterval (p. 265) Gets or sets the UpdateInterval.
Method AddComment() (p. 266) Creates a new child Comment.
Method AddImage(string) (p. 266) 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. 266) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 266)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 267)

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPartInfoTool

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.

Declaration Syntax
public string Text { get; }

UpdateInterval
Gets or sets the UpdateInterval.

Release 2022 R2 - © 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 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.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
 CondensedPartInterface

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 118: Members

Property AllSelection (p. 267) No details are provided for this entry.
Property NamedSelection (p. 268) Gets or Sets NamedSelection
Property RemotePointSelection (p. 268) Gets or Sets RemotePointSelection
Property Type (p. 268) Gets or Sets Condensed part interface
type

AllSelection
No details are provided for this entry.

Release 2022 R2 - © 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 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.

Declaration Syntax
public class CondensedPartInterfaces : IReadOnlyList<CondensedPartInterface>, IReadOnlyCollection<Con-
densedPartInterface>, IEnumerable<CondensedPartInterface>, IEnumerable

Table 119: Members

Property Item (p. 269) Condensed part interface at the given index.
Method Add() (p. 269) Add new condensed part interface
Method Clear() (p. 269) Clears all the condensed part interfaces
Method RemoveAt(int) (p. 269) Remove condensed part interface at the given
index

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
 ConstructionGeometry

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)

Parameters
index(int)

No details are provided for this entry.

ConstructionGeometry
Defines a ConstructionGeometry.

Release 2022 R2 - © 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 class ConstructionGeometry : DataModelObject, IFolderDataModelObject

Table 120: Members

Property Children (p. 270) Gets the list of children.

Property Comments (p. 271) Gets the list of associated comments.
Property DataModelObjectCategory (p. 271) Gets the current DataModelObject's category.
Property Figures (p. 271) Gets the list of associated figures.
Property Images (p. 271) Gets the list of associated images.
Property InternalObject (p. 271) Gets the internal object. For advanced usage only.
Property ShowMesh (p. 271) Gets or sets the ShowMesh.
Method AddComment() (p. 272) Creates a new child Comment.
Method AddConstructionLine() (p. 272) Creates a new ConstructionLine
Method AddConstructionPoint() (p. 272) Creates a new ConstructionPoint
Method AddFigure() (p. 272) Creates a new child Figure.
Method AddImage(string) (p. 272) 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. 273) Creates a new Path
Method AddSolid() (p. 273) Creates a new Solid
Method AddSTL() (p. 273) Creates a new STL
Method AddSurface() (p. 273) Creates a new Surface
Method Delete() (p. 273) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 273)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 274)
Method UpdateAllSolids() (p. 274) Update all solid parts under the Construction
Geometry folder.
Method UpdateSolids() (p. 274) Update only the solids that are activated

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
 ConstructionGeometry

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; }

ShowMesh
Gets or sets the ShowMesh.

Declaration Syntax
public bool ShowMesh { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
Ansys.ACT.Automation.Mechanical Namespace

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)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
 ConstructionGeometry

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
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.)

UpdateAllSolids()
Update all solid parts under the Construction Geometry folder.

Declaration Syntax
public virtual void UpdateAllSolids()

UpdateSolids()
Update only the solids that are activated

Declaration Syntax
public virtual void UpdateSolids()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
 ConstructionPoint

ConstructionPoint
Defines a ConstructionPoint.

Declaration Syntax
public class ConstructionPoint : DataModelObject, IFolderDataModelObject

Table 121: Members

Property Children (p. 275) Gets the list of children.

Property Comments (p. 275) Gets the list of associated comments.
Property DataModelObjectCategory (p. 276) Gets the current DataModelObject's category.
Property Figures (p. 276) Gets the list of associated figures.
Property Images (p. 276) Gets the list of associated images.
Property InternalObject (p. 276) Gets the internal object. For advanced usage only.
Property LocationX (p. 276) Gets or sets the LocationX.
Property LocationY (p. 276) Gets or sets the LocationY.
Property LocationZ (p. 277) Gets or sets the LocationZ.
Property SetLocation (p. 277) Sets the point location.
Method AddComment() (p. 277) Creates a new child Comment.
Method AddFigure() (p. 277) Creates a new child Figure.
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 Delete() (p. 278) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 278)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 278)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2022 R2 - © 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 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.

Declaration Syntax
public Quantity LocationX { set;get; }

LocationY
Gets or sets the LocationY.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
 ConstructionPoint

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.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
 ContactDebonding

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 122: Members

Property ContactRegion (p. 279) Gets or sets the ContactRegion.

Property CriticalRate (p. 280) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 280) Gets the current DataModelObject's
category.
Property GenerationMethod (p. 280) Gets or sets the GenerationMethod.
Property InitialCrack (p. 280) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 280) Gets or sets the InitialTimeStep.
Property InternalObject (p. 280) Gets the internal object. For advanced usage
only.
Property Material (p. 281) Gets or sets the Material.
Property MaximumTimeStep (p. 281) Gets or sets the MaximumTimeStep.
Property Method (p. 281) Gets or sets the Method.
Property MinimumTimeStep (p. 281) Gets or sets the MinimumTimeStep.
Property Suppressed (p. 281) Gets or sets the Suppressed.
Property Type (p. 281) Gets the Type.
Method AddCommandSnippet() (p. 282) Creates a new CommandSnippet
Method Delete() (p. 282) Run the Delete action.

ContactRegion
Gets or sets the ContactRegion.

Declaration Syntax
public ContactRegion ContactRegion { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public IDSDelaminationAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
 ContactDebonding

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.

Declaration Syntax
public DelaminationType Type { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
Ansys.ACT.Automation.Mechanical Namespace

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 123: Members

Property Children (p. 591) Gets the list of children.

(Inherited from
MeshConnectionBase (p. 590).)
Property Comments (p. 591) Gets the list of associated comments.

(Inherited from
MeshConnectionBase (p. 590).)
Property DataModelObjectCategory (p. 284)Gets the current DataModelObject's
category.
Property Figures (p. 592) Gets the list of associated figures.

(Inherited from
MeshConnectionBase (p. 590).)
Property Images (p. 592) Gets the list of associated images.

(Inherited from
MeshConnectionBase (p. 590).)
Property InternalObject (p. 284) Gets the internal object. For advanced usage
only.
Property MasterBodies (p. 592) Gets the MasterBodies.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
 ContactMatch

(Inherited from
MeshConnectionBase (p. 590).)
Property MasterLocation (p. 592) Gets or sets the MasterLocation.

(Inherited from
MeshConnectionBase (p. 590).)
Property ScopeMode (p. 592) Gets the ScopeMode.

(Inherited from
MeshConnectionBase (p. 590).)
Property ScopingMethod (p. 593) No details are provided for this entry.

(Inherited from
MeshConnectionBase (p. 590).)
Property SlaveBodies (p. 593) Gets the SlaveBodies.

(Inherited from
MeshConnectionBase (p. 590).)
Property SlaveLocation (p. 593) Gets or sets the SlaveLocation.

(Inherited from
MeshConnectionBase (p. 590).)
Property SnapToBoundary (p. 593) Gets or sets the SnapToBoundary.

(Inherited from
MeshConnectionBase (p. 590).)
Property SnapTolerance (p. 593) Gets or sets the SnapTolerance.

(Inherited from
MeshConnectionBase (p. 590).)
Property SnapType (p. 593) Gets or sets the SnapType.

(Inherited from
MeshConnectionBase (p. 590).)
Property Suppressed (p. 594) Gets or sets the Suppressed.

(Inherited from
MeshConnectionBase (p. 590).)
Property ToleranceSlider (p. 594) Gets or sets the ToleranceSlider.

(Inherited from
MeshConnectionBase (p. 590).)
Property ToleranceType (p. 594) Gets or sets the ToleranceType.

(Inherited from
MeshConnectionBase (p. 590).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
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 IDSMeshConnectionAuto InternalObject { get; }

ContactMatchGroup
Defines a ContactMatchGroup.

Defines a ContactMatchGroup.

Declaration Syntax
public class ContactMatchGroup : ConnectionGroup

Table 124: Members

Property ActiveConnections (p. 3141) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 3140).)

Property AutomaticFixedJoints (p. 3142) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 3140).)

Property Children (p. 3142) Gets the list of children.

(Inherited from ConnectionGroup (p. 3140).)

Property Comments (p. 3142) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 3140).)

Property Connections (p. 3142) Gets the Connections.

(Inherited from ConnectionGroup (p. 3140).)

Property ConnectionType (p. 3142) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 3140).)

Property CylindricalFaces (p. 3142) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 3140).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
 ContactMatchGroup

Property DataModelObjectCategory (p. 286) Gets the current DataModelObject's category.

Property EdgeEdge (p. 3143) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 3140).)

Property EdgeOverlapTolerance (p. 3143) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceAngleTolerance (p. 3143) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceEdge (p. 3143) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceFace (p. 3143) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceFaceDetectionAngleTolerence (p. 3144)Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceOverlapTolerance (p. 3144) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property Figures (p. 3144) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 3140).)

Property GroupBy (p. 3144) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 3140).)

Property Images (p. 3144) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 3140).)

Property InternalObject (p. 286) Gets the internal object. For advanced usage
only.
Property Location (p. 3145) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 3140).)

Property MinimumDistancePercentage (p. 3145) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 3140).)

Property MinimumDistanceValue (p. 3145) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 3140).)

Property Priority (p. 3145) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 3140).)

Property RevoluteJoints (p. 3145) Gets or sets the RevoluteJoints.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 3140).)

Property SearchAcross (p. 3145) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 3140).)

Property Suppressed (p. 3146) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 3140).)

Property ThicknessScaleFactor (p. 3146) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceSlider (p. 3146) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceType (p. 3146) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceValue (p. 3146) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 3140).)

Property UseRange (p. 3146) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 3140).)

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; }

ContactSolutionInformation
Defines a ContactSolutionInformation.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
 ContactSolutionInformation

Declaration Syntax
public class ContactSolutionInformation : DataModelObject, IFolderDataModelObject

Table 125: Members

Property Children (p. 287) Gets the list of children.

Property Comments (p. 287) Gets the list of associated comments.
Property DataModelObjectCategory (p. 287) Gets the current DataModelObject's category.
Property Images (p. 288) Gets the list of associated images.
Property InternalObject (p. 288) Gets the internal object. For advanced usage only.
Property UpdateInterval (p. 288) Gets or sets the UpdateInterval.
Method AddComment() (p. 288) Creates a new child Comment.
Method AddImage(string) (p. 288) 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. 289) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 289)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 289)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
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 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)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
 ContactSolutionInformation

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
Ansys.ACT.Automation.Mechanical Namespace

CoordinateSystem
Defines a CoordinateSystem.

Declaration Syntax
public class CoordinateSystem : ImportedDataModelObject, ICoordinateSystem, ICoordinateSystemSe-
lection, IFolderDataModelObject

Table 126: Members

Property APDLName (p. 292) Gets or sets the APDLName.

Property Children (p. 292) Gets the list of children.
Property Comments (p. 292) Gets the list of associated comments.
Property CoordinateSystemID (p. 292) Gets or sets the CoordinateSystemID.
Property CoordinateSystemIDGeneration (p. 292) Gets or sets the CoordinateSystemIDGeneration.
Property CoordinateSystemType (p. 293) Gets or sets the CoordinateSystemType.
Property DataModelObjectCategory (p. 293) Gets the current DataModelObject's category.
Property Figures (p. 293) Gets the list of associated figures.
Property GloballyAvailable (p. 293) Gets or sets the GloballyAvailable.
Property Images (p. 293) Gets the list of associated images.
Property InternalObject (p. 293) Gets the internal object. For advanced usage only.
Property IsGlobal (p. 294) Gets the IsGlobal.
Property OriginDefineBy (p. 294) Gets or sets the origin define by.
Property OriginLocation (p. 294) Gets or sets the origin location.
Property OriginX (p. 294) Gets or sets the origin X coordinate.
Property OriginY (p. 294) Gets or sets the origin Y coordinate.
Property OriginZ (p. 294) Gets or sets the origin Z coordinate.
Property PrimaryAxis (p. 295) Gets or sets the PrimaryAxis.
Property PrimaryAxisDefineBy (p. 295) Gets or sets the PrimaryAxisDefineBy.
Property PrimaryAxisDirection (p. 295) Gets or sets the Principal Axis Direction.
Property PrimaryAxisLocation (p. 295) Gets or sets the principal axis geometry selection.
Property SecondaryAxis (p. 295) Gets or sets the SecondaryAxis.
Property SecondaryAxisDefineBy (p. 295) Gets or sets the SecondaryAxisDefineBy.
Property SecondaryAxisDirection (p. 296) Gets the Secondary Axis Direction.
Property SecondaryAxisLocation (p. 296) Gets or sets the orientation about principal axis
geometry selection.
Property Suppressed (p. 296) Gets or sets the Suppressed.
Property TransformationCount (p. 296) Gets the number of transformations.
Property TransformedConfiguration (p. 296) Gets the TransformedConfiguration.
Property XAxisData (p. 296) Gets the XAxisData.
Property YAxisData (p. 297) Gets the YAxisData.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

Property ZAxisData (p. 297) Gets the ZAxisData.

Method AddComment() (p. 297) Creates a new child Comment.
Method AddFigure() (p. 297) Creates a new child Figure.
Method AddImage(string) (p. 297) 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 AddTransformation(TransformationType, Adds a new transformation.
CoordinateSystemAxisType) (p. 298)
Method CreateConstructionSurface() (p. 298) Run the CreateConstructionSurface action.
Method CreateSectionPlane() (p. 298) Run the CreateSectionPlane action.
Method Delete() (p. 298) Run the Delete action.
Method FlipX() (p. 299) Flips the X Axis of the coordinate system
Method FlipY() (p. 299) Flips the Y Axis of the coordinate system
Method FlipZ() (p. 299) Flips the Z Axis of the coordinate system
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 299)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 299)
Method GetTransformationValue(uint) (p. 300) Gets the value of a transformation.
Method MoveTransformationDown(uint) (p. 300) Moves a transformation down.
Method MoveTransformationUp(uint) (p. 301) Moves a transformation up.
Method OffsetX() (p. 301) Creates an offset in the X Axis direction of the
coordinate system
Method OffsetX(object) (p. 301) Creates an offset in the X Axis direction of the
coordinate system
Method OffsetY() (p. 301) Creates an offset in the Y Axis direction of the
coordinate system
Method OffsetY(object) (p. 301) Creates an offset in the Y Axis direction of the
coordinate system
Method OffsetZ() (p. 302) Creates an offset in the Z Axis direction of the
coordinate system
Method OffsetZ(object) (p. 302) Creates an offset in the Z Axis direction of the
coordinate system
Method RemoveTransformation(uint) (p. 302) Removes a tranformation.
Method RotateX() (p. 302) Creates a rotation about the X Axis of the
coordinate system
Method RotateX(object) (p. 303) Creates a rotation about the X Axis of the
coordinate system
Method RotateY() (p. 303) Creates a rotation about the Y Axis of the
coordinate system
Method RotateY(object) (p. 303) Creates a rotation about the Y Axis of the
coordinate system

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
Ansys.ACT.Automation.Mechanical Namespace

Method RotateZ() (p. 303) Creates a rotation about the Z Axis of the
coordinate system
Method RotateZ(object) (p. 304) Creates a rotation about the Z Axis of the
coordinate system
Method SetOriginLocation(Quantity, Quantity, Changes the origin location.
Quantity) (p. 304)
Method SetTransformationValue(uint, Sets the value of a transformation.
object) (p. 304)

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

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; }

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.

Release 2022 R2 - © 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 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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
Ansys.ACT.Automation.Mechanical Namespace

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()

CreateSectionPlane()
Run the CreateSectionPlane action.

Declaration Syntax
public virtual void CreateSectionPlane()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

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)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
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.)

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).

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).

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

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.

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
Ansys.ACT.Automation.Mechanical Namespace

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.

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystem

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)

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

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).

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystems

value(object)

Value of the transformation.

CoordinateSystems
Defines a CoordinateSystems.

Declaration Syntax
public class CoordinateSystems : DataModelObject, IFolderDataModelObject

Table 127: Members

Property Children (p. 305) Gets the list of children.

Property Comments (p. 305) Gets the list of associated comments.
Property DataModelObjectCategory (p. 306) Gets the current DataModelObject's category.
Property Figures (p. 306) Gets the list of associated figures.
Property Images (p. 306) Gets the list of associated images.
Property InternalObject (p. 306) Gets the internal object. For advanced usage only.
Method AddComment() (p. 306) Creates a new child Comment.
Method AddCoordinateSystem() (p. 306) Creates a new CoordinateSystem
Method AddFigure() (p. 307) Creates a new child Figure.
Method AddImage(string) (p. 307) 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. 307)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 308)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
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 IDSCoordinateSystemGroupAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddCoordinateSystem()
Creates a new CoordinateSystem

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoordinateSystems

Declaration Syntax
public virtual CoordinateSystem AddCoordinateSystem()

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.)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
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.)

CoSimulationPin
Defines a CoSimulationPin.

Declaration Syntax
public class CoSimulationPin : DataModelObject, IFolderDataModelObject

Table 128: Members

Property Children (p. 309) Gets the list of children.

Property DataModelObjectCategory (p. 309) Gets the current DataModelObject's
category.
Property DOF (p. 309) Gets or sets the DOF.
Property InternalObject (p. 309) Gets the internal object. For advanced usage
only.
Property JointType (p. 309) Gets or sets the Joint Type.
Property PinBehavior (p. 310) Gets or sets the Pin Behavior.
Property PinNature (p. 310) Gets or sets the Pin Nature.
Property Scope (p. 310) Gets or sets the Joint through Scope.
Property Suppressed (p. 310) Gets or sets the Suppressed.
Method Delete() (p. 310) Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
 CoSimulationPin

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.

IList<ChildrenType>) (p. 310)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 311)

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
Ansys.ACT.Automation.Mechanical Namespace

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
 Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.

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.)

Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEl-

lipticalCrack instead.
Defines a Crack.

Declaration Syntax
public class Crack : GenericCrack

Table 129: Members

Property AlignWithFaceNormal (p. 313) Gets or sets the AlignWithFaceNormal.

Property BottomFaceNodes (p. 313) Gets or sets the BottomFaceNodes.
Property Children (p. 418) Gets the list of children.

Release 2022 R2 - © 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 CircumferentialDivisions (p. 313)
Property Comments (p. 418)
Property Contact1Nodes (p. 313)
Property ContactPairsNodes (p. 313)
Property CoordinateSystem (p. 313)
Property CrackFacesNodes (p. 314)
Property CrackFrontDivisions (p. 314)
Property CrackFrontNodes (p. 314)
Property CrackShape (p. 314)
Property CrackSourceType (p. 314)
Property DataModelObjectCategory (p. 418)
Property FaceTopNodes (p. 314)
Property Figures (p. 418)
Property FractureAffectedZone (p. 315)
Property FractureAffectedZoneHeight (p. 315) Gets or sets the FractureAffectedZoneHeight.
Property Images (p. 418)
Property InternalObject (p. 315)
Property LargestContourRadius (p. 315)
Property Location (p. 315)
Property MajorRadius (p. 315)
Property MeshContours (p. 316)
Property MinorRadius (p. 316)
Property ProjectToNearestSurface (p. 316)
Property SolutionContours (p. 316)
Property Suppressed (p. 316)
Property Target1Nodes (p. 316)
Property XScaleFactor (p. 317)
Property YScaleFactor (p. 317)
Property ZScaleFactor (p. 317)
Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
312
(Inherited from GenericCrack (p. 417).)
Gets or sets the CircumferentialDivisions.
Gets the list of associated comments.
(Inherited from GenericCrack (p. 417).)
Gets or sets the Contact1Nodes.
Gets or sets the ContactPairsNodes.
Gets or sets the CoordinateSystem.
Gets or sets the CrackFacesNodes.
Gets or sets the CrackFrontDivisions.
Gets or sets the CrackFrontNodes.
Gets the CrackShape.
Gets the CrackSourceType.
Gets the current DataModelObject's
category.
(Inherited from GenericCrack (p. 417).)
Gets or sets the FaceTopNodes.
Gets the list of associated figures.
(Inherited from GenericCrack (p. 417).)
Gets or sets the FractureAffectedZone.
Gets the list of associated images.
(Inherited from GenericCrack (p. 417).)
Gets the internal object. For advanced usage
only.
Gets or sets the LargestContourRadius.
Gets the Location.
Gets or sets the MajorRadius.
Gets or sets the MeshContours.
Gets or sets the MinorRadius.
Gets or sets the ProjectToNearestSurface.
Gets or sets the SolutionContours.
Gets or sets the Suppressed.
Gets or sets the Target1Nodes.
Gets or sets the XScaleFactor.
Gets or sets the YScaleFactor.
Gets or sets the ZScaleFactor.
of ANSYS, Inc. and its subsidiaries and affiliates.
 Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.

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.

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
 Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack
instead.

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
 Criterion

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; }

Criterion
Defines a Criterion.

Declaration Syntax
public class Criterion : ImportedDataModelObject, IFolderDataModelObject

Table 130: Members

Property Children (p. 318) Gets the list of children.

Property Comments (p. 318) Gets the list of associated comments.
Property DataModelObjectCategory (p. 318) Gets the current DataModelObject's category.
Property Figures (p. 318) Gets the list of associated figures.
Property Images (p. 318) Gets the list of associated images.
Property InternalObject (p. 319) Gets the internal object. For advanced usage only.
Property Suppressed (p. 319) Gets or sets the Suppressed.
Method AddComment() (p. 319) Creates a new child Comment.
Method AddFigure() (p. 319) Creates a new child Figure.
Method AddImage(string) (p. 319) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
Ansys.ACT.Automation.Mechanical Namespace

image will be a screen capture of the Geometry

window.
Method Delete() (p. 320) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 320)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 320)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
 Criterion

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.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
 CriterionConstraint

CriterionConstraint
Defines a CriterionConstraint.

Declaration Syntax
public class CriterionConstraint : ResponseConstraint

Table 131: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property Criterion (p. 321) Gets or sets the Criterion.
Property DataModelObjectCategory (p. 321)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InitialValue (p. 321) Gets the InitialValue.
Property InternalObject (p. 322) Gets the internal object. For advanced usage only.
Property LowerBound (p. 322) Gets or sets the LowerBound.
Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

Property UpperBound (p. 322) Gets or sets the UpperBound.

Criterion
Gets or sets the Criterion.

Declaration Syntax
public Criterion Criterion { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InitialValue
Gets the InitialValue.

Release 2022 R2 - © 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 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.

Declaration Syntax
public class CrossSection : ImportedDataModelObject, IFolderDataModelObject

Table 132: Members

Property Children (p. 323) Gets the list of children.

Property Comments (p. 323) Gets the list of associated comments.
Property DataModelObjectCategory (p. 323) Gets the current DataModelObject's category.
Property Figures (p. 323) Gets the list of associated figures.
Property Images (p. 323) Gets the list of associated images.
Property InternalObject (p. 324) Gets the internal object. For advanced usage only.
Method AddComment() (p. 324) Creates a new child Comment.
Method AddFigure() (p. 324) Creates a new child Figure.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
 CrossSection

Method AddImage(string) (p. 324) 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. 324) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 325)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 325)

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 2022 R2 - © 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 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.

Declaration Syntax
public virtual Image AddImage(string filePath)

Parameters
filePath(string)

Full path of file. Defaults to None.

Delete()
Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
 CrossSection

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
Ansys.ACT.Automation.Mechanical Namespace

CrossSections
Defines a CrossSections.

Declaration Syntax
public class CrossSections : DataModelObject, IFolderDataModelObject

Table 133: Members

Property Children (p. 327) Gets the list of children.

Property Comments (p. 327) Gets the list of associated comments.
Property DataModelObjectCategory (p. 327) Gets the current DataModelObject's category.
Property Figures (p. 327) Gets the list of associated figures.
Property Images (p. 327) Gets the list of associated images.
Property InternalObject (p. 327) Gets the internal object. For advanced usage
only.
Method AddChannelCrossSection() (p. 328) Creates a new ChannelCrossSection
Method AddCircularCrossSection() (p. 328) Creates a new CircularCrossSection
Method AddCircularTubeCrossSection() (p. 328) Creates a new CircularTubeCrossSection
Method AddComment() (p. 328) Creates a new child Comment.
Method AddFigure() (p. 328) Creates a new child Figure.
Method AddHatCrossSection() (p. 328) Creates a new HatCrossSection
Method AddHollowRectangularCrossSection() (p. 329) Creates a new HollowRectangularCrossSection
Method AddICrossSection() (p. 329) Creates a new ICrossSection
Method AddImage(string) (p. 329) 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. 329) Creates a new LCrossSection
Method AddRectangularCrossSection() (p. 329) Creates a new RectangularCrossSection
Method AddTCrossSection() (p. 330) Creates a new TCrossSection
Method AddUserDefinedCrossSection() (p. 330) Creates a new UserDefinedCrossSection
Method AddZCrossSection() (p. 330) Creates a new ZCrossSection
Method Delete() (p. 330) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 330)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 331)
Method NameCrossSectionsUniquely() (p. 331) programmatically give each of the Cross
Section objects a unique name .

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
 CrossSections

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 IDSCrossSectionGroupAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual Figure AddFigure()

AddHatCrossSection()
Creates a new HatCrossSection

Declaration Syntax
public virtual HatCrossSection AddHatCrossSection()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
 CrossSections

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

Declaration Syntax
public virtual LCrossSection AddLCrossSection()

AddRectangularCrossSection()
Creates a new RectangularCrossSection

Declaration Syntax
public virtual RectangularCrossSection AddRectangularCrossSection()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual IList<ChildrenType> GetChildren<ChildrenType>(bool recurses, IList<ChildrenType>
children)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
 CyclicManufacturingConstraint

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()

CyclicManufacturingConstraint
Defines a CyclicManufacturingConstraint.

Declaration Syntax
public class CyclicManufacturingConstraint : ManufacturingConstraint

Table 134: Members

Property Axis (p. 332) Gets or sets the Axis.

Property Children (p. 556) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
Ansys.ACT.Automation.Mechanical Namespace

Property CoordinateSystem (p. 332)
Property DataModelObjectCategory (p. 332)Gets the current DataModelObject's
category.
Property InternalObject (p. 332)
Property Location (p. 333)
Property NumberofSectors (p. 333)
Property ScopingMethod (p. 333)
Property Selection (p. 557)
(Inherited from
ManufacturingConstraint (p. 556).)
Gets or sets the CoordinateSystem.
Gets the internal object. For advanced usage
only.
Gets or sets the Location.
Gets or sets the NumberofSectors.
Gets or sets the ScopingMethod.
Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
 CyclicRegion

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.

Declaration Syntax
public class CyclicRegion : SymmetryGeneral

Table 135: Members

Property Children (p. 1006) Gets the list of children.

(Inherited from SymmetryGeneral (p. 1005).)

Property Comments (p. 1006) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1005).)

Property CoordinateSystem (p. 1006) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1005).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
Ansys.ACT.Automation.Mechanical Namespace

Property DataModelObjectCategory (p. 334)Gets the current DataModelObject's

category.
Property Figures (p. 1006) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1005).)

Property HighBoundaryLocation (p. 1007) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1005).)

Property Images (p. 1007) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1005).)

Property InternalObject (p. 334) Gets the internal object. For advanced usage
only.
Property Location (p. 1007) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 1005).)

Property LowBoundaryLocation (p. 1007) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1005).)

Property ScopeMode (p. 1007) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1005).)

Property Suppressed (p. 1008) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1005).)

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; }

DirectMorph
Defines a DirectMorph.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectMorph

Declaration Syntax
public class DirectMorph : DataModelObject, IFolderDataModelObject

Table 136: Members

Property Children (p. 335) Gets the list of children.

Property DataModelObjectCategory (p. 335) Gets the current DataModelObject's
category.
Property DisplacementFile (p. 335) Gets or sets the DisplacementFile.
Property InternalObject (p. 336) Gets the internal object. For advanced
usage only.
Property Location (p. 336) Gets or sets the Location.
Property ScaleFactor (p. 336) Gets or sets the ScaleFactor.
Property Suppressed (p. 336) Gets or sets the Suppressed.
Method Clear() (p. 336) clear morph control
Method Delete() (p. 336) Run the Delete action.
Method Generate() (p. 337) Generate morph control
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 337)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 337)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
Ansys.ACT.Automation.Mechanical Namespace

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; }

ScaleFactor
Gets or sets the ScaleFactor.

Declaration Syntax
public int 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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectMorph

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)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
Ansys.ACT.Automation.Mechanical Namespace

DisplacementConstraint
Defines a DisplacementConstraint.

Declaration Syntax
public class DisplacementConstraint : ResponseConstraint

Table 137: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 338)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 338) Gets the internal object. For advanced usage only.
Property Location (p. 338) Gets or sets the Location.
Property ScopingMethod (p. 339) Gets or sets the ScopingMethod.
Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

Property XComponentMax (p. 339) Gets or sets the XComponentMax.
Property YComponentMax (p. 339) Gets or sets the YComponentMax.
Property ZComponentMax (p. 339) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
 DistributedMass

Declaration Syntax
public ISelectionInfo Location { 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.

Declaration Syntax
public Field ZComponentMax { get; }

DistributedMass
Defines a DistributedMass.

Declaration Syntax
public class DistributedMass : GenericPointMass

Table 138: Members

Property Children (p. 425) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from GenericPointMass (p. 424).)

Property Comments (p. 425) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 424).)

Property DataModelObjectCategory (p. 340)Gets the current DataModelObject's category.
Property Figures (p. 425) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 424).)

Property Images (p. 426) Gets the list of associated images.

(Inherited from GenericPointMass (p. 424).)

Property InternalObject (p. 340) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 426) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 424).)

Property Location (p. 426) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 424).)

Property MassPerUnitArea (p. 340) Gets or sets the MassPerUnitArea.
Property MassType (p. 341) Gets or sets the MassType.
Property RemotePoint (p. 426) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 424).)

Property Suppressed (p. 341) Gets or sets the Suppressed.
Property TotalMass (p. 341) Gets or sets the TotalMass.

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; }

MassPerUnitArea
Gets or sets the MassPerUnitArea.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
340 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 139: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property ComplianceLimit (p. 342) Gets or sets the ComplianceLimit.
Property DataModelObjectCategory (p. 342)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 342) Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
Ansys.ACT.Automation.Mechanical Namespace

Property MaximumValue (p. 342) Gets or sets the MaximumValue.

Property MinimumValue (p. 342) Gets or sets the MinimumValue.
Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElementOrientation

ElementOrientation
Defines a ElementOrientation.

Declaration Syntax
public class ElementOrientation : ImportedDataModelObject, IFolderDataModelObject

Table 140: Members

Property AxisEdgeOrientation (p. 343) Gets or sets the AxisEdgeOrientation.

Property AxisSurfaceOrientation (p. 344) Gets or sets the AxisSurfaceOrientation.
Property BodyLocation (p. 344) Gets or sets the BodyLocation.
Property Children (p. 344) Gets the list of children.
Property Comments (p. 344) Gets the list of associated comments.
Property CoordinateSystem (p. 344) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 344) Gets the current DataModelObject's category.
Property EdgeLocation (p. 345) Gets or sets the EdgeLocation.
Property Figures (p. 345) Gets the list of associated figures.
Property Images (p. 345) Gets the list of associated images.
Property InternalObject (p. 345) Gets the internal object. For advanced usage only.
Property OrientationGuideDefinedBy (p. 345) Gets or sets the OrientationGuideDefinedBy.
Property Suppressed (p. 345) Gets or sets the Suppressed.
Property SurfaceLocation (p. 346) Gets or sets the SurfaceLocation.
Method AddComment() (p. 346) Creates a new child Comment.
Method AddFigure() (p. 346) Creates a new child Figure.
Method AddImage(string) (p. 346) 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. 346) Run the Delete action.
Method GenerateOrientations() (p. 347) Runs the GenerateOrientations acton.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 347)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 347)

AxisEdgeOrientation
Gets or sets the AxisEdgeOrientation.

Declaration Syntax
public ElementOrientationAxisType AxisEdgeOrientation { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
Ansys.ACT.Automation.Mechanical Namespace

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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElementOrientation

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
Ansys.ACT.Automation.Mechanical Namespace

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElementOrientation

GenerateOrientations()
Runs the GenerateOrientations acton.

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)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
Ansys.ACT.Automation.Mechanical Namespace
EllipticalCrack
Defines a EllipticalCrack.
Declaration Syntax
public class EllipticalCrack : GenericCrack
Table 141: Members
Property BottomFaceNodes (p. 349)
Property Children (p. 418)
Property CircumferentialDivisions (p. 349)
Property Comments (p. 418)
Property Contact1Nodes (p. 349)
Property ContactPairsNodes (p. 349)
Property CoordinateSystem (p. 349)
Property CrackFacesNodes (p. 350)
Property CrackFrontDivisions (p. 350)
Property CrackFrontNodes (p. 350)
Property CrackMeshMethod (p. 350)
Property CrackShape (p. 350)
Property CrackSourceType (p. 350)
Property DataModelObjectCategory (p. 351)
Property Figures (p. 418)
Property FractureAffectedZone (p. 351)
Property FractureAffectedZoneHeight (p. 351) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 351)
Property GrowthRate (p. 351)
Property Images (p. 418)
Property InternalObject (p. 351)
Property LargestContourRadius (p. 352)
Property Location (p. 352)
Property MajorRadius (p. 352)
Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
348
Gets or sets the BottomFaceNodes.
Gets the list of children.
(Inherited from GenericCrack (p. 417).)
Gets or sets the CircumferentialDivisions.
Gets the list of associated comments.
(Inherited from GenericCrack (p. 417).)
Gets or sets the Contact1Nodes.
Gets or sets the ContactPairsNodes.
Gets or sets the CoordinateSystem.
Gets or sets the CrackFacesNodes.
Gets or sets the CrackFrontDivisions.
Gets or sets the CrackFrontNodes.
Gets or sets the CrackMeshMethod.
Gets the CrackShape.
Gets the CrackSourceType.
Gets the current DataModelObject's
category.
Gets the list of associated figures.
(Inherited from GenericCrack (p. 417).)
Gets or sets the FractureAffectedZone.
Gets or sets the FrontElementSize.
Gets or sets the GrowthRate.
Gets the list of associated images.
(Inherited from GenericCrack (p. 417).)
Gets the internal object. For advanced usage
only.
Gets or sets the LargestContourRadius.
Gets or sets the Location.
Gets or sets the MajorRadius.
of ANSYS, Inc. and its subsidiaries and affiliates.
 EllipticalCrack

Property MeshContours (p. 352) Gets or sets the MeshContours.

Property MinorRadius (p. 352) Gets or sets the MinorRadius.
Property SolutionContours (p. 352) Gets or sets the SolutionContours.
Property Suppressed (p. 353) Gets or sets the Suppressed.
Property Target1Nodes (p. 353) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 353) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 353) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 353) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 353) 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; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.
 EllipticalCrack

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 351
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; }

SolutionContours
Gets or sets the SolutionContours.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
352 of ANSYS, Inc. and its subsidiaries and affiliates.
 EllipticalCrack

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; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 353
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public double ZScaleFactor { set;get; }

EndRelease
Defines a EndRelease.

Declaration Syntax
public class EndRelease : DataModelObject, IFolderDataModelObject

Table 142: Members

Property Behavior (p. 355) Gets or sets the Behavior.

Property Children (p. 355) Gets the list of children.
Property Comments (p. 355) Gets the list of associated comments.
Property CoordinateSystem (p. 355) Gets or sets the Coordinate System.
Property DataModelObjectCategory (p. 355) Gets the current DataModelObject's category.
Property EdgeLocation (p. 355) Gets or sets the EdgeLocation.
Property Figures (p. 356) Gets the list of associated figures.
Property Images (p. 356) Gets the list of associated images.
Property IndependentEdges (p. 356) Gets or sets the IndependentEdges.
Property InternalObject (p. 356) Gets the internal object. For advanced usage only.
Property RotationX (p. 356) Gets or sets the RotationX.
Property RotationY (p. 356) Gets or sets the RotationY.
Property RotationZ (p. 357) Gets or sets the RotationZ.
Property Suppressed (p. 357) Gets or sets the Suppressed.
Property TranslationX (p. 357) Gets or sets the TranslationX.
Property TranslationY (p. 357) Gets or sets the TranslationY.
Property TranslationZ (p. 357) Gets or sets the TranslationZ.
Property VertexLocation (p. 357) Gets or sets the VertexLocation.
Method AddComment() (p. 358) Creates a new child Comment.
Method AddFigure() (p. 358) Creates a new child Figure.
Method AddImage(string) (p. 358) 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. 358) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 358)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 359)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
354 of ANSYS, Inc. and its subsidiaries and affiliates.
 EndRelease

Behavior
Gets or sets the Behavior.

Declaration Syntax
public BeamEndReleaseBehavior 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 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 355
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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
 EndRelease

RotationZ
Gets or sets the RotationZ.

Declaration Syntax
public FixedOrFree RotationZ { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 357
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExclusionRegion

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.)

ExclusionRegion
Defines a ExclusionRegion.

Declaration Syntax
public class ExclusionRegion : OptimizationRegionBaseClass

Table 143: Members

Property Children (p. 715) Gets the list of children.

(Inherited from OptimizationRegionBaseClass (p. 715).)

Property DataModelObjectCategory (p. 360) Gets the current DataModelObject's category.
Property ExclusionRegionLocation (p. 715) Gets or sets the ExclusionRegionLocation.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 359
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from OptimizationRegionBaseClass (p. 715).)

Property ExclusionScopingMethod (p. 715) Gets or sets the ExclusionScopingMethod.

(Inherited from OptimizationRegionBaseClass (p. 715).)

Property InternalObject (p. 360) Gets the internal object. For advanced usage only.
Property Suppressed (p. 360) Gets or sets the Suppressed.
Method CopyTo(ExclusionRegion) (p. 360) Copies all visible properties from this object to another.
Override because of copy order of properties
Method RenameBasedOnDefinition() (p. 361) Run the RenameBasedOnDefinition action.

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 IDSOptimizationRegionAuto InternalObject { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

CopyTo(ExclusionRegion)
Copies all visible properties from this object to another. Override because of copy order of properties

Declaration Syntax
public virtual void CopyTo(ExclusionRegion other)

Parameters
other(ExclusionRegion)

The destination ExclusionRegion for the data

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExpansionSettings

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

ExpansionSettings
Defines a ExpansionSettings.

Declaration Syntax
public class ExpansionSettings : DataModelObject, IFolderDataModelObject

Table 144: Members

Property Children (p. 362) Gets the list of children.

Property CleanupOptionalFiles (p. 362) Gets or sets the
CleanupOptionalFiles.
Property Comments (p. 362) Gets the list of associated comments.
Property CondensedPartExpansionType (p. 362) Gets or sets the
CondensedPartExpansionType.
Property DataModelObjectCategory (p. 363) Gets the current DataModelObject's
category.
Property ExpandAfterUsePassFailure (p. 363) Gets or sets the
ExpandAfterUsePassFailure.
Property Figures (p. 363) Gets the list of associated figures.
Property GeneralMiscellaneous (p. 363) Gets or sets the
GeneralMiscellaneous.
Property Images (p. 363) Gets the list of associated images.
Property InternalObject (p. 363) Gets the internal object. For
advanced usage only.
Property NodalForces (p. 364) Gets or sets the NodalForces.
Property Strain (p. 364) Gets or sets the Strain.
Property Stress (p. 364) Gets or sets the Stress.
Property Suppressed (p. 364) Gets or sets the Suppressed.
Method AddComment() (p. 364) Creates a new child Comment.
Method AddFigure() (p. 364) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 361
Ansys.ACT.Automation.Mechanical Namespace

Method ClearGeneratedData() (p. 365) Run the ClearGeneratedData action.

Method Delete() (p. 365) Run the Delete action.
Method EvaluateAllResults() (p. 365) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 365) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 366) type.
Method GetCompletedExpansionState(CondensedPart) (p. 366) Gets the completed expansion state
of a given Condensed Part
Method GetExpansionState(CondensedPart) (p. 367) Gets the requested expansion state
of a given Condensed Part
Method PerformExpansionPass() (p. 367) Run the PerformExpansionPass
action.
Method SetExpansionState(CondensedPart, Sets the requested expansion state
CondensedPartExpansionState) (p. 367) of a given Condensed Part

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

CleanupOptionalFiles
Gets or sets the CleanupOptionalFiles.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExpansionSettings

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 363
Ansys.ACT.Automation.Mechanical Namespace

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExpansionSettings

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()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 365
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.)

GetCompletedExpansionState(CondensedPart)
Gets the completed expansion state of a given Condensed Part

Declaration Syntax
public virtual CondensedPartExpansionState GetCompletedExpansionState(CondensedPart condensed-
Part)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExpansionSettings

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

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 367
Ansys.ACT.Automation.Mechanical Namespace

ExternalEnhancedModel
Defines a ExternalEnhancedModel.

Declaration Syntax
public class ExternalEnhancedModel : DataModelObject, IFolderDataModelObject

Table 145: Members

Property Children (p. 368) Gets the list of children.

Property Comments (p. 368) Gets the list of associated comments.
Property DataModelObjectCategory (p. 369) Gets the current DataModelObject's category.
Property Figures (p. 369) Gets the list of associated figures.
Property Images (p. 369) Gets the list of associated images.
Property InternalObject (p. 369) Gets the internal object. For advanced usage only.
Property LayerToDisplay (p. 369) Gets or sets the LayerToDisplay.
Property MaximumNumberOfLayers (p. 369) Gets the MaximumNumberOfLayers.
Property NonlinearEffects (p. 370) Gets or sets the NonlinearEffects.
Property Suppressed (p. 370) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 370) Gets or sets the ThermalStrainEffects.
Property Type (p. 370) Gets the Type.
Method AddComment() (p. 370) Creates a new child Comment.
Method AddFigure() (p. 370) Creates a new child Figure.
Method AddImage(string) (p. 371) 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. 371)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 371)
Method RegroupToDefault() (p. 372) Run the RegroupToDefault action.

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExternalEnhancedModel

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 IDSExternalEnhancedModelAuto InternalObject { get; }

LayerToDisplay
Gets or sets the LayerToDisplay.

Declaration Syntax
public int LayerToDisplay { set;get; }

MaximumNumberOfLayers
Gets the MaximumNumberOfLayers.

Release 2022 R2 - © 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 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.

Declaration Syntax
public ExternalEnhancedModelType Type { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddFigure()
Creates a new child Figure.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExternalEnhancedModel

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 371
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.)

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 146: Members

Property Children (p. 373) Gets the list of children.

Property Comments (p. 373) Gets the list of associated comments.
Property Count (p. 373) Gets the NumberOfRows.
Property DataModelObjectCategory (p. 373) Gets the current DataModelObject's category.
Property Figures (p. 373) Gets the list of associated figures.
Property Images (p. 374) Gets the list of associated images.
Property InternalObject (p. 374) Gets the internal object. For advanced usage only.
Property Suppressed (p. 374) Gets or sets the Suppressed.
Method AddComment() (p. 374) Creates a new child Comment.
Method AddFigure() (p. 374) Creates a new child Figure.
Method AddImage(string) (p. 374) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExternalModelDataColl

image will be a screen capture of the Geometry

window.
Method Delete() (p. 375) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 375)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 375)

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.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 373
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 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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
 ExternalModelDataColl

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 375
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.)

ExtrusionManufacturingConstraint
Defines a ExtrusionManufacturingConstraint.

Declaration Syntax
public class ExtrusionManufacturingConstraint : ManufacturingConstraint

Table 147: Members

Property Axis (p. 376) Gets or sets the Axis.

Property Children (p. 556) Gets the list of children.

Property CoordinateSystem (p. 377)
Property DataModelObjectCategory (p. 377)Gets the current DataModelObject's
category.
Property InternalObject (p. 377)
Property Location (p. 377)
Property ScopingMethod (p. 377)
Property Selection (p. 557)
(Inherited from
ManufacturingConstraint (p. 556).)
Gets or sets the CoordinateSystem.
Gets the internal object. For advanced usage
only.
Gets or sets the Location.
Gets or sets the ScopingMethod.
Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueCombination

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; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

FatigueCombination
Defines a FatigueCombination.

Release 2022 R2 - © 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 class FatigueCombination : DataModelObject, IFolderDataModelObject

Table 148: Members

Property Children (p. 378) Gets the list of children.

Property Comments (p. 378) Gets the list of associated comments.
Property DataModelObjectCategory (p. 378) Gets the current DataModelObject's category.
Property Images (p. 379) Gets the list of associated images.
Property InternalObject (p. 379) Gets the internal object. For advanced usage only.
Method AddComment() (p. 379) Creates a new child Comment.
Method AddDamage() (p. 379) Creates a new FatigueDamage
Method AddImage(string) (p. 379) 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. 380) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 380)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 380)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueCombination

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueTool

FatigueTool
Defines a FatigueTool.

Declaration Syntax
public class FatigueTool : DataModelObject, IFolderDataModelObject

Table 149: Members

Property AnalysisType (p. 382) Gets or sets the AnalysisType.

Property BinSize (p. 382) Gets or sets the BinSize.
Property Children (p. 382) Gets the list of children.
Property Comments (p. 382) Gets the list of associated comments.
Property CustomUnitsName (p. 383) Gets or sets the Custom Units Name.
Property DataModelObjectCategory (p. 383) Gets the current DataModelObject's category.
Property DisplayTime (p. 383) Gets or sets the DisplayTime.
Property ExposureDuration (p. 383) Gets or sets the ExposureDuration.
Property FatigueStrengthFactor (p. 383) Gets or sets the FatigueStrengthFactor.
Property Frequency (p. 383) Gets or sets the Frequency.
Property FrequencySelection (p. 384) Gets or sets the FrequencySelection.
Property HistoryDataLocation (p. 384) Gets or sets the HistoryDataLocation.
Property Images (p. 384) Gets the list of associated images.
Property InfiniteLife (p. 384) Gets or sets the InfiniteLife.
Property InternalObject (p. 384) Gets the internal object. For advanced usage only.
Property LoadingRatio (p. 384) Gets or sets the LoadingRatio.
Property LoadingType (p. 385) Gets or sets the LoadingType.
Property MaximumDataPointsToPlot (p. 385) Gets or sets the MaximumDataPointsToPlot.
Property MeanStressTheory (p. 385) Gets or sets the MeanStressTheory.
Property MethodSelection (p. 385) Gets or sets the MethodSelection.
Property OneCycleIsEqualTo (p. 385) Gets or sets the OneCycleIsEqualTo.
Property ResultsInput (p. 385) Gets or sets the ResultsInput.
Property ScaleFactor (p. 386) Gets or sets the ScaleFactor.
Property StressComponent (p. 386) Gets or sets the StressComponent.
Property UnitsName (p. 386) Gets or sets the UnitsName.
Property UseQuickRainflowCounting (p. 386) Gets or sets the UseQuickRainflowCounting.
Method AddBiaxialityIndication() (p. 386) Creates a new FatigueBiaxialityIndication
Method AddComment() (p. 386) Creates a new child Comment.
Method AddDamage() (p. 387) Creates a new FatigueDamage
Method AddDamageMatrix() (p. 387) Creates a new FatigueDamageMatrix
Method AddEquivalentAlternativeStress() (p. 387) Creates a new FatigueEquivalentAlternativeStress

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
Ansys.ACT.Automation.Mechanical Namespace

Method AddFatigueSensitivity() (p. 387) Creates a new FatigueSensitivity

Method AddHysteresis() (p. 387) Creates a new FatigueHysteresis
Method AddImage(string) (p. 387) 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. 388) Creates a new FatigueLife
Method AddRainflowMatrix() (p. 388) Creates a new FatigueRainflowMatrix
Method AddSafetyFactor() (p. 388) Creates a new FatigueSafetyFactor
Method Delete() (p. 388) Run the Delete action.
Method EvaluateAllResults() (p. 388) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 389)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 389)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueTool

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueTool

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueTool

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()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
Ansys.ACT.Automation.Mechanical Namespace

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()

AddRainflowMatrix()
Creates a new FatigueRainflowMatrix

Declaration Syntax
public virtual FatigueRainflowMatrix AddRainflowMatrix()

AddSafetyFactor()
Creates a new FatigueSafetyFactor

Declaration Syntax
public virtual FatigueSafetyFactor AddSafetyFactor()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
 FatigueTool

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.

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 389
Ansys.ACT.Automation.Mechanical Namespace

FeatureDetection
Defines a FeatureDetection.

Declaration Syntax
public class FeatureDetection : DataModelObject, IFolderDataModelObject

Table 150: Members

Property Children (p. 390) Gets the list of children.

Property Comments (p. 391) Gets the list of associated comments.
Property DataModelObjectCategory (p. 391) Gets the current DataModelObject's category.
Property Definition (p. 391) Get the FeatureDetectionDefinition object. This
object contains all the Feature Detection data like
Fillets, Holes, Chamfers detection.
Property Images (p. 391) Gets the list of associated images.
Property InternalObject (p. 391) Gets the internal object. For advanced usage only.
Property Location (p. 391) Gets or sets the Location.
Property NamedSelection (p. 392) Gets or sets the NamedSelection.
Property ScopingMethod (p. 392) Gets or sets the ScopingMethod.
Method AddComment() (p. 392) Creates a new child Comment.
Method AddImage(string) (p. 392) 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. 392) Run the ClearGeneratedData action.
Method Delete() (p. 393) Run the Delete action.
Method DetectFeatures() (p. 393) No details are provided for this entry.
Method EvaluateAllResults() (p. 393) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 393)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 393)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetection

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 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 391
Ansys.ACT.Automation.Mechanical Namespace

NamedSelection
Gets or sets the NamedSelection.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetection

Delete()
Run the Delete action.

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.

Release 2022 R2 - © 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 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.)

FeatureDetectionDefinition
No details are provided for this entry.

Declaration Syntax
public class FeatureDetectionDefinition

Table 151: Members

Property FeatureDetectionCount (p. 395) 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. 396)
Method DeleteFeatureDetection(uint) (p. 396) Delete a FeatureDetection from the Feature
Detection Definition
Method ExecuteDetectFeatures() (p. 397) No details are provided for this entry.
Method Export(string) (p. 397) Export Feature Detection Definition data to
Comma Separated Value (CSV) files
Method GetFeatureCriteriaAngle(uint) (p. 397) Gets the Angle property at given
FeatureDetection index and BaseCase index
Method GetFeatureCriteriaMaxBound(uint) (p. 397) Gets the Max-Bound property at given
FeatureDetection index and BaseCase index
Method GetFeatureCriteriaMinBound(uint) (p. 398) Gets the Min Bound property at given
FeatureDetection index and BaseCase index
Method GetFeatureCriteriaValue(uint) (p. 398) Gets the Value property at given
FeatureDetection index and BaseCase index

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetectionDefinition

Method GetFeatureDetectionCriteria(uint) (p. 398) Gets the Feature Detection Criteria property
at given index
Method GetFeatureDetectionName(uint) (p. 399) Gets the FeatureDetection Name property at
given index
Method GetFeatureDetectionOperator(uint) (p. 399) Gets the Feature Detection Operator property
at given index
Method GetFeatureDetectionTreatment(uint) (p. 399) Gets the Feature Detection Criteria property
at given index
Method GetFeatureDetectionType(uint) (p. 400) Gets the Feature Detection Type property at
given index
Method Import(string) (p. 400) Import Feature Detection Definition data from
Comma Separated Value (CSV) files
Method SetFeatureCriteriaAngle(uint, Sets the Angle property at given
double) (p. 400) FeatureDetection index and BaseCase index
Method SetFeatureCriteriaMaxBound(uint, Sets the Max Bound property at given
double) (p. 400) FeatureDetection index and BaseCase index
Method SetFeatureCriteriaMinBound(uint, Sets the Min Bound property at given
double) (p. 401) FeatureDetection index and BaseCase index
Method SetFeatureCriteriaValue(uint, Sets the Value property at given
double) (p. 401) FeatureDetection index and BaseCase index
Method SetFeatureDetectionCriteria(uint, Sets the Feature Detection Criteria property at
FeatureDetectionCriteria) (p. 402) given index
Method SetFeatureDetectionName(uint, Sets the FeatureDetection Name property at
string) (p. 402) given index
Method SetFeatureDetectionOperator(uint, Sets the Feature Detection Operator property
FeatureDetectionOperator) (p. 402) at given index
Method SetFeatureDetectionOptions(bool, bool, Set Feature Detection Solid / Sheet / Beta
bool) (p. 403) settings

Set solid option.>

Set solid option.>

Set solid option.>

Method SetFeatureDetectionTreatment(uint, Sets the Feature Detection Criteria property at
FeatureDetectionTreatment) (p. 403) given index
Method SetFeatureDetectionType(uint, Sets the Feature Detection Type property at
FeatureDetectionType) (p. 404) given index

FeatureDetectionCount
Gets the number of Feature Detections

Declaration Syntax
public uint FeatureDetectionCount { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 395
Ansys.ACT.Automation.Mechanical Namespace

AddFeatureDetection(string, int, int, int, double, double, double, double,

int)
Add a FeatureDetection to the FeatureDetection Definition

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetectionDefinition

Declaration Syntax
public void DeleteFeatureDetection(uint index)

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

Release 2022 R2 - © 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 double GetFeatureCriteriaMaxBound(uint index)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
398 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetectionDefinition

Parameters
index(uint)

Index to get Feature Detection Type at

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 399
Ansys.ACT.Automation.Mechanical Namespace

GetFeatureDetectionType(uint)
Gets the Feature Detection Type property at given index

Declaration Syntax
public FeatureDetectionType GetFeatureDetectionType(uint index)

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
400 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetectionDefinition

Declaration Syntax
public void SetFeatureCriteriaMaxBound(uint index, double value)

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 401
Ansys.ACT.Automation.Mechanical Namespace

SetFeatureDetectionCriteria(uint, FeatureDetectionCriteria)
Sets the Feature Detection Criteria property at given index

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
 FeatureDetectionDefinition

value(FeatureDetectionOperator)

FeatureDetectionOperator

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 403
Ansys.ACT.Automation.Mechanical Namespace

SetFeatureDetectionType(uint, FeatureDetectionType)
Sets the Feature Detection Type property at given index

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 152: Members

Property Children (p. 405) Gets the list of children.

Property Comments (p. 405) Gets the list of associated comments.
Property DataModelObjectCategory (p. 405) Gets the current DataModelObject's
category.
Property InternalObject (p. 405) Gets the internal object. For advanced
usage only.
Property Text (p. 405) Gets or sets the Text.
Method AddComment() (p. 405) Creates a new child Comment.
Method Delete() (p. 406) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 406)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 406)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
404 of ANSYS, Inc. and its subsidiaries and affiliates.
 Figure

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; }

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 405
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
 Fracture

Fracture
Defines a Fracture.

Declaration Syntax
public class Fracture : DataModelObject, IFolderDataModelObject

Table 153: Members

Property Children (p. 408) Gets the list of children.

Property Comments (p. 408) Gets the list of associated comments.
Property DataModelObjectCategory (p. 408) Gets the current DataModelObject's category.
Property Figures (p. 408) Gets the list of associated figures.
Property Images (p. 408) Gets the list of associated images.
Property InternalObject (p. 408) Gets the internal object. For advanced usage
only.
Property RemeshHexDominantToTetrahedral (p. 409) Gets or sets the
RemeshHexDominantToTetrahedral.
Method AddArbitraryCrack() (p. 409) Creates a new ArbitraryCrack
Method AddComment() (p. 409) Creates a new child Comment.
Method AddContactDebonding() (p. 409) Creates a new ContactDebonding
Method AddCrack() ***OBSOLETE*** Use the Creates a new child Crack.
method AddArbitraryCrack or
AddSemiEllipticalCrack instead. (p. 409)
Method AddEllipticalCrack() (p. 409) Creates a new EllipticalCrack
Method AddFigure() (p. 410) Creates a new child Figure.
Method AddImage(string) (p. 410) 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. 410) Creates a new InterfaceDelamination
Method AddPreMeshedCrack() (p. 410) Creates a new PreMeshedCrack
Method AddRingCrack() (p. 410) Creates a new RingCrack
Method AddSemiEllipticalCrack() (p. 411) Creates a new SemiEllipticalCrack
Method AddSMARTCrackGrowth() (p. 411) Creates a new SMARTCrackGrowth
Method Delete() (p. 411) Run the Delete action.
Method GenerateAllCrackMesh() (p. 411) Run the GenerateAllCrackMesh action.
Method GenerateAllInterfaceDelamination() (p. 411) Generate all interfaces delamination from an
external model.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 411)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 412)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
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; }

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 IDSFractureGroupAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
 Fracture

RemeshHexDominantToTetrahedral
Gets or sets the RemeshHexDominantToTetrahedral.

Declaration Syntax
public bool RemeshHexDominantToTetrahedral { 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()

AddCrack() ***OBSOLETE*** Use the method AddArbitraryCrack or

AddSemiEllipticalCrack instead.
Creates a new child Crack.

Declaration Syntax
public virtual Crack AddCrack()

AddEllipticalCrack()
Creates a new EllipticalCrack

Declaration Syntax
public virtual EllipticalCrack AddEllipticalCrack()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
 Fracture

AddSemiEllipticalCrack()
Creates a new SemiEllipticalCrack

Declaration Syntax
public virtual SemiEllipticalCrack AddSemiEllipticalCrack()

AddSMARTCrackGrowth()
Creates a new SMARTCrackGrowth

Declaration Syntax
public virtual SMARTCrackGrowth AddSMARTCrackGrowth()

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
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.)

GeneralAxisymmetric
Defines a GeneralAxisymmetric.

Declaration Syntax
public class GeneralAxisymmetric : ImportedDataModelObject, IFolderDataModelObject

Table 154: Members

Property Axis (p. 413) Gets or sets the Axis.

Property Children (p. 413) Gets the list of children.
Property Comments (p. 413) Gets the list of associated comments.
Property CoordinateSystem (p. 414) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 414) Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeneralAxisymmetric

Property EndPlane (p. 414) Gets or sets the EndPlane.

Property Figures (p. 414) Gets the list of associated figures.
Property Images (p. 414) Gets the list of associated images.
Property InternalObject (p. 414) Gets the internal object. For advanced usage only.
Property Location (p. 415) Gets or sets the Location.
Property NodalPlanes (p. 415) Gets or sets the NodalPlanes.
Property NodalPlanesVisible (p. 415) Gets or sets the NodalPlanesVisible.
Property StartPlane (p. 415) Gets or sets the StartPlane.
Property Suppressed (p. 415) Gets or sets the Suppressed.
Method AddComment() (p. 415) Creates a new child Comment.
Method AddFigure() (p. 416) Creates a new child Figure.
Method AddImage(string) (p. 416) 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. 416) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 416)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 417)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeneralAxisymmetricAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeneralAxisymmetric

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.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
 GenericCrack

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 155: Members

Property Children (p. 418) Gets the list of children.

Property Comments (p. 418) Gets the list of associated comments.
Property DataModelObjectCategory (p. 418) Gets the current DataModelObject's category.
Property Figures (p. 418) Gets the list of associated figures.
Property Images (p. 418) Gets the list of associated images.
Property InternalObject (p. 419) Gets the internal object. For advanced usage only.
Method AddCommandSnippet() (p. 419) Creates a new CommandSnippet
Method AddComment() (p. 419) Creates a new child Comment.
Method AddFigure() (p. 419) Creates a new child Figure.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 417
Ansys.ACT.Automation.Mechanical Namespace

Method AddImage(string) (p. 419) 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. 420) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 420)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 420)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
418 of ANSYS, Inc. and its subsidiaries and affiliates.
 GenericCrack

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 419
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
420 of ANSYS, Inc. and its subsidiaries and affiliates.
 GenericDelamination

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 156: Members

Property Children (p. 421) Gets the list of children.

Property Comments (p. 422) Gets the list of associated comments.
Property DataModelObjectCategory (p. 422) Gets the current DataModelObject's category.
Property Figures (p. 422) Gets the list of associated figures.
Property Images (p. 422) Gets the list of associated images.
Property InternalObject (p. 422) Gets the internal object. For advanced usage only.
Method AddCommandSnippet() (p. 422) Creates a new CommandSnippet
Method AddComment() (p. 423) Creates a new child Comment.
Method AddFigure() (p. 423) Creates a new child Figure.
Method AddImage(string) (p. 423) 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. 423) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 423)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 424)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 421
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 IDSDelaminationAuto InternalObject { get; }

AddCommandSnippet()
Creates a new CommandSnippet

Declaration Syntax
public virtual CommandSnippet AddCommandSnippet()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
422 of ANSYS, Inc. and its subsidiaries and affiliates.
 GenericDelamination

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 423
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.)

GenericPointMass
Defines a GenericPointMass.

Declaration Syntax
public abstract class GenericPointMass : ImportedDataModelObject, IFolderDataModelObject

Table 157: Members

Property Children (p. 425) Gets the list of children.

Property Comments (p. 425) Gets the list of associated comments.
Property DataModelObjectCategory (p. 425) Gets the current DataModelObject's category.
Property Figures (p. 425) Gets the list of associated figures.
Property Images (p. 426) Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
424 of ANSYS, Inc. and its subsidiaries and affiliates.
 GenericPointMass

Property InternalObject (p. 426) Gets the internal object. For advanced usage only.
Property IsDistributedMass (p. 426) Gets the IsDistributedMass.
Property Location (p. 426) Gets or sets the Geometry.
Property RemotePoint (p. 426) Gets the remote point associated to the point mass.
Method AddCommandSnippet() (p. 426) Creates a new CommandSnippet
Method AddComment() (p. 427) Creates a new child Comment.
Method AddFigure() (p. 427) Creates a new child Figure.
Method AddImage(string) (p. 427) 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. 427) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 427)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 428)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 425
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 IDSPointMassAuto InternalObject { get; }

IsDistributedMass
Gets the IsDistributedMass.

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
 GenericPointMass

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 427
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.)

Geometry
Defines a Geometry.

Declaration Syntax
public class Geometry : DataModelObject, IFolderDataModelObject

Table 158: Members

Property ActiveBodies (p. 432) Gets the ActiveBodies.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
428 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

Property AnalysisType (p. 432) Gets the AnalysisType.

Property AssignMaterialOnUpdate (p. 432) Gets or sets the
AssignMaterialOnUpdate.
Property AttachFileViaTempFile (p. 433) Gets or sets the
AttachFileViaTempFile.
Property AttributeKey (p. 433) Gets the AttributeKey.
Property Attributes (p. 433) Gets the Attributes.
Property Average (p. 433) Gets the Average.
Property Bodies (p. 433) Gets the Bodies.
Property CanChangeCADUnits (p. 433) Gets the
CanChangeCADUnits.
Property Children (p. 434) Gets the list of children.
Property Comments (p. 434) Gets the list of associated
comments.
Property ComparePartsOnUpdate (p. 434) Gets the
ComparePartsOnUpdate.
Property ComparePartsTolerance (p. 434) Gets the
ComparePartsTolerance.
Property DataModelObjectCategory (p. 434) Gets the current
DataModelObject's category.
Property DecomposeDisjointGeometry (p. 434) Gets the
DecomposeDisjointGeometry.
Property DisplayStyle (p. 435) Gets or sets the DisplayStyle.
Property ElementControl (p. 435) Gets or sets the
ElementControl.
Property Elements (p. 435) Gets the Elements.
Property EnclosureAndSymmetryProcessing (p. 435) Gets the
EnclosureAndSymmetryProcessing.
Property EndPlaneRotationAboutX (p. 435) Gets or sets the
EndPlaneRotationAboutX.
Property EndPlaneRotationAboutY (p. 435) Gets or sets the
EndPlaneRotationAboutY.
Property FiberLength (p. 436) Gets or sets the FiberLength.
Property Figures (p. 436) Gets the list of associated
figures.
Property GeometryPreferencesReadOnly (p. 436) Gets the
GeometryPreferencesReadOnly.
Property Images (p. 436) Gets the list of associated
images.
Property ImportCoordinateSystems (p. 436) Gets the
ImportCoordinateSystems.
Property InternalObject (p. 436) Gets the internal object. For
advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 429
Ansys.ACT.Automation.Mechanical Namespace

Property LengthUnit (p. 437) Gets the LengthUnit.

Property LengthX (p. 437) Gets the LengthX.
Property LengthY (p. 437) Gets the LengthY.
Property LengthZ (p. 437) Gets the LengthZ.
Property LineBodies (p. 437) Gets the LineBodies.
Property Mass (p. 437) Gets the Mass.
Property MaterialProperties (p. 438) Gets the MaterialProperties.
Property Maximum (p. 438) Gets the Maximum.
Property MeshMetric (p. 438) Gets the MeshMetric.
Property MeshVolume (p. 438) Gets the MeshVolume.
Property Minimum (p. 438) Gets the Minimum.
Property MixedImportResolution (p. 438) Gets the
MixedImportResolution.
Property Model2DBehavior (p. 439) Gets or sets the
Model2DBehavior.
Property NamedSelectionKey (p. 439) Gets the
NamedSelectionKey.
Property NamedSelections (p. 439) Gets the NamedSelections.
Property Nodes (p. 439) Gets the Nodes.
Property ParameterKey (p. 439) Gets the ParameterKey.
Property Parameters (p. 439) Gets the Parameters.
Property PercentGeometryAssociativityTolerance (p. 440) Gets or sets the Percent
tolerance used for Geometry
Associativity.
Property ReaderModeSavesUpdatedFile (p. 440) Gets or sets the
ReaderModeSavesUpdatedFile.
Property ScaleFactorValue (p. 440) Gets or sets the
ScaleFactorValue.
Property SheetSurfaceArea (p. 440) Gets the SheetSurfaceArea.
Property SmartCADUpdate (p. 440) Gets the SmartCADUpdate.
Property SolidBodies (p. 440) Gets the SolidBodies.
Property Source (p. 441) Gets the Source.
Property StandardDeviation (p. 441) Gets the StandardDeviation.
Property SurfaceArea (p. 441) Gets the SurfaceArea.
Property SurfaceBodies (p. 441) Gets the SurfaceBodies.
Property TemporaryDirectory (p. 441) Gets or sets the
TemporaryDirectory.
Property Tolerance2D (p. 441) Gets or sets the
Tolerance2D.
Property Type (p. 442) Gets the Type.
Property UseAssociativity (p. 442) Gets the UseAssociativity.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
430 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

Property UseInstances (p. 442) Gets the UseInstances.

Property Volume (p. 442) Gets the Volume.
Property XCentroid (p. 442) Gets the XCentroid.
Property YCentroid (p. 442) Gets the YCentroid.
Property ZCentroid (p. 443) Gets the ZCentroid.
Method AddComment() (p. 443) Creates a new child
Comment.
Method AddDistributedMass() (p. 443) Creates a new
DistributedMass
Method AddElementOrientation() (p. 443) Creates a new
ElementOrientation
Method AddFigure() (p. 443) Creates a new child Figure.
Method AddImage(string) (p. 443) 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 AddLayeredSection() (p. 444) Creates a new child
LayeredSection.
Method AddPointMass() (p. 444) Creates a new PointMass
Method AddSurfaceCoating() (p. 444) Creates a new
SurfaceCoating
Method AddThermalPointMass() (p. 444) Creates a new
ThermalPointMass
Method AddThickness() (p. 444) Creates a new child
Thickness.
Method FreezeMeshOnAllParts() (p. 445) Run the
FreezeMeshOnAllParts
action.
Method GetBody(IBaseGeoBody) (p. 445) Gets the Body associated
with the given IGeoBody
Method GetChildren<ChildrenType>(bool, IList<ChildrenType>) (p. 445) Gets the list of children,
filtered by type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children,
IList<IDataModelObject>) (p. 445) filtered by type.
Method GetPart(IBaseGeoPart) (p. 446) Gets the Part associated with
the given IGeoPart
Method InvertSuppressedBodySet() (p. 446) Invert all parts Suppressed
property.
Method RefreshInvalidReferenceData() (p. 446) Searches for tree items with
missing Scoping.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
Ansys.ACT.Automation.Mechanical Namespace

Method RescopeFromGeomAssocData(bool) (p. 447) Scopes objects to all the

matches found for missing
geometry.
Method RescopeGivenObjectsFromGeomAssocData(IAnsUINTColl) (p. 447) Scopes the objects from the
list to all the matches found
for missing geometry.
Method ResetBodyColors() (p. 447) Run the ResetBodyColors
action.
Method RunGeometryAssociativityQueries() (p. 447) Searches for potential
geometry matches for the
missing scoping of all the
objects.
Method UnfreezeMeshOnAllParts() (p. 447) Run the
UnfreezeMeshOnAllParts
action.
Method UnsuppressAllBodies() (p. 448) Unsuppress all the bodies
that were suppressed.
Method UpdateGeometryFromSource() (p. 448) 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

AttachFileViaTempFile
Gets or sets the AttachFileViaTempFile.

Declaration Syntax
public bool AttachFileViaTempFile { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 433
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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
434 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

DisplayStyle
Gets or sets the DisplayStyle.

Declaration Syntax
public PrototypeDisplayStyleType DisplayStyle { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 435
Ansys.ACT.Automation.Mechanical Namespace

FiberLength
Gets or sets the FiberLength.

Declaration Syntax
public Quantity FiberLength { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
436 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

LengthUnit
Gets the LengthUnit.

Declaration Syntax
public WBUnitSystemType LengthUnit { 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; }

LineBodies
Gets the LineBodies.

Declaration Syntax
public bool LineBodies { get; }

Mass
Gets the Mass.

Declaration Syntax
public Quantity Mass { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 437
Ansys.ACT.Automation.Mechanical Namespace

MaterialProperties
Gets the MaterialProperties.

Declaration Syntax
public bool MaterialProperties { get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
438 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

Model2DBehavior
Gets or sets the Model2DBehavior.

Declaration Syntax
public Model2DBehavior Model2DBehavior { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 439
Ansys.ACT.Automation.Mechanical Namespace

PercentGeometryAssociativityTolerance
Gets or sets the Percent tolerance used for Geometry Associativity.

Declaration Syntax
public double PercentGeometryAssociativityTolerance { set;get; }

ReaderModeSavesUpdatedFile
Gets or sets the ReaderModeSavesUpdatedFile.

Declaration Syntax
public bool ReaderModeSavesUpdatedFile { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
440 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

Source
Gets the Source.

Declaration Syntax
public string Source { get; }

StandardDeviation
Gets the StandardDeviation.

Declaration Syntax
public double StandardDeviation { get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 441
Ansys.ACT.Automation.Mechanical Namespace

Type
Gets the Type.

Declaration Syntax
public string Type { get; }

UseAssociativity
Gets the UseAssociativity.

Declaration Syntax
public bool UseAssociativity { get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
442 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

ZCentroid
Gets the ZCentroid.

Declaration Syntax
public Quantity ZCentroid { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 443
Ansys.ACT.Automation.Mechanical Namespace

Parameters
filePath(string)

Full path of file. Defaults to None.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
444 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

FreezeMeshOnAllParts()
Run the FreezeMeshOnAllParts action.

Declaration Syntax
public virtual void FreezeMeshOnAllParts()

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.

Release 2022 R2 - © 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 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.)

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()

RefreshInvalidReferenceData()
Searches for tree items with missing Scoping.

Declaration Syntax
public virtual void RefreshInvalidReferenceData()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
446 of ANSYS, Inc. and its subsidiaries and affiliates.
 Geometry

RescopeFromGeomAssocData(bool)
Scopes objects to all the matches found for missing geometry.

Declaration Syntax
public virtual void RescopeFromGeomAssocData(bool removeRelinked)

Parameters
removeRelinked(bool)

No details are provided for this entry.

RescopeGivenObjectsFromGeomAssocData(IAnsUINTColl)
Scopes the objects from the list to all the matches found for missing geometry.

Declaration Syntax
public virtual void RescopeGivenObjectsFromGeomAssocData(IAnsUINTColl itemsToRelink)

Parameters
itemsToRelink(IAnsUINTColl)

No details are provided for this entry.

ResetBodyColors()
Run the ResetBodyColors action.

Declaration Syntax
public virtual void ResetBodyColors()

RunGeometryAssociativityQueries()
Searches for potential geometry matches for the missing scoping of all the objects.

Declaration Syntax
public virtual void RunGeometryAssociativityQueries()

UnfreezeMeshOnAllParts()
Run the UnfreezeMeshOnAllParts action.

Release 2022 R2 - © 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 virtual void UnfreezeMeshOnAllParts()

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 159: Members

Property Children (p. 449) Gets the list of children.

Property Comments (p. 449) Gets the list of associated comments.
Property DataModelObjectCategory (p. 449) Gets the current DataModelObject's category.
Property Figures (p. 449) Gets the list of associated figures.
Property Images (p. 449) Gets the list of associated images.
Property InternalObject (p. 450) Gets the internal object. For advanced usage only.
Property LengthUnits (p. 450) Gets or sets the LengthUnits.
Property ShowAlways (p. 450) Gets or sets the ShowAlways.
Property Statistics (p. 450) Gets the Statistics.
Property Suppressed (p. 450) Gets or sets the Suppressed.
Method AddComment() (p. 450) Creates a new child Comment.
Method AddFigure() (p. 451) Creates a new child Figure.
Method AddImage(string) (p. 451) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
448 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeometryFileContainer

image will be a screen capture of the Geometry

window.
Method Delete() (p. 451) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 451)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 452)
Method ImportSTL() (p. 452) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 449
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
450 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeometryFileContainer

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)

Parameters
recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 451
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.)

ImportSTL()
Run the ImportSTL action.

Declaration Syntax
public virtual void ImportSTL()

GeometryImport
Defines a GeometryImport.

Declaration Syntax
public class GeometryImport : DataModelObject, IRemovableDataModelObject, IFolderDataModelObject

Table 160: Members

Property Children (p. 453) Gets the list of children.

Property Comments (p. 453) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
452 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeometryImport

Property DataModelObjectCategory (p. 454) Gets the current DataModelObject's category.

Property Figures (p. 454) Gets the list of associated figures.
Property Images (p. 454) Gets the list of associated images.
Property InternalObject (p. 454) Gets the internal object. For advanced usage only.
Property Parts (p. 454) List of parts created by the most recent import
operation.
Method AddComment() (p. 454) Creates a new child Comment.
Method AddFigure() (p. 455) Creates a new child Figure.
Method AddImage(string) (p. 455) 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. 455)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 456)
Method GetFormat() (p. 456) Gets the format of the geometry file/data for the
most recent import.
Method GetGeometryURI() (p. 456) Gets the Geometry URI for the most recent import.
The Universal Resource Identifier, which on disk
would be "file://..."
Method GetPreferences() (p. 456) 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. 457) 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.

Release 2022 R2 - © 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 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 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeometryImport

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.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 455
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.)

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
456 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeometryImportGroup

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).
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 161: Members

Property Children (p. 458) Gets the list of children.

Property Comments (p. 458) Gets the list of associated comments.
Property Count (p. 458) Get the number of child

GeometryImport instances.
Property DataModelObjectCategory (p. 458) Gets the current DataModelObject's category.
Property Figures (p. 459) Gets the list of associated figures.
Property Images (p. 459) Gets the list of associated images.
Property InternalObject (p. 459) Gets the internal object. For advanced usage only.
Property Item (p. 459) Get a child

GeometryImport instance.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 457
Ansys.ACT.Automation.Mechanical Namespace

Method AddComment() (p. 459) Creates a new child Comment.

Method AddFigure() (p. 459) Creates a new child Figure.
Method AddGeometryImport() (p. 460) Create the object for working with an imported
part.
Method AddImage(string) (p. 460) 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. 460)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 461)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
458 of ANSYS, Inc. and its subsidiaries and affiliates.
 GeometryImportGroup

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 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.

Release 2022 R2 - © 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 Figure AddFigure()

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.)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
460 of ANSYS, Inc. and its subsidiaries and affiliates.
 GlobalVonMisesStressConstraint

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.)

GlobalVonMisesStressConstraint
Defines a GlobalVonMisesStressConstraint.

Defines a GlobalVonMisesStressConstraint.

Declaration Syntax
public class GlobalVonMisesStressConstraint : ResponseConstraint

Table 162: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 462)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 462) Gets the internal object. For advanced usage only.
Property Maximum (p. 462) Gets or sets the Maximum.
Property ScopingMethod (p. 462) Gets or sets the ScopingMethod.
Property StressType (p. 462) Gets or sets the StressType.
Property Suppressed (p. 810) Gets or sets the Suppressed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 461
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ResponseConstraint (p. 809).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
462 of ANSYS, Inc. and its subsidiaries and affiliates.
 HatCrossSection

Declaration Syntax
public class HatCrossSection : CrossSection

Table 163: Members

Property Area (p. 463) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 463)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 464) Gets the internal object. For advanced usage
only.
Property IYY (p. 464) Gets the IYY.
Property IZZ (p. 464) Gets the IZZ.
Property Thick1 (p. 464) Gets or sets the Thick1.
Property Thick2 (p. 464) Gets or sets the Thick2.
Property Thick3 (p. 464) Gets or sets the Thick3.
Property Thick4 (p. 465) Gets or sets the Thick4.
Property Thick5 (p. 465) Gets or sets the Thick5.
Property Width1 (p. 465) Gets or sets the Width1.
Property Width2 (p. 465) Gets or sets the Width2.
Property Width3 (p. 465) Gets or sets the Width3.
Property Width4 (p. 465) Gets or sets the Width4.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 463
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
464 of ANSYS, Inc. and its subsidiaries and affiliates.
 HatCrossSection

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 465
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity Width4 { set;get; }

HollowRectangularCrossSection
Defines a HollowRectangularCrossSection.

Declaration Syntax
public class HollowRectangularCrossSection : CrossSection

Table 164: Members

Property Area (p. 466) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 467)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 467) Gets the internal object. For advanced usage
only.
Property IYY (p. 467) Gets the IYY.
Property IZZ (p. 467) Gets the IZZ.
Property Thick1 (p. 467) Gets or sets the Thick1.
Property Thick2 (p. 467) Gets or sets the Thick2.
Property Thick3 (p. 468) Gets or sets the Thick3.
Property Thick4 (p. 468) Gets or sets the Thick4.
Property Width1 (p. 468) Gets or sets the Width1.
Property Width2 (p. 468) Gets or sets the Width2.

Area
Gets the Area.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
466 of ANSYS, Inc. and its subsidiaries and affiliates.
 HollowRectangularCrossSection

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 467
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
468 of ANSYS, Inc. and its subsidiaries and affiliates.
 HousingConstraint

Declaration Syntax
public class HousingConstraint : ManufacturingConstraint

Table 165: Members

Property Children (p. 556) Gets the list of children.

Property DataModelObjectCategory (p. 469)Gets the current DataModelObject's
category.
Property HousingLocation (p. 469)
Property HousingScopingMethod (p. 469)
Property InternalObject (p. 470)
Property Location (p. 470)
Property ScopingMethod (p. 470)
Property Selection (p. 557)
(Inherited from
ManufacturingConstraint (p. 556).)
Gets or sets the HousingLocation.
Gets or sets the HousingScopingMethod.
Gets the internal object. For advanced usage
only.
Gets or sets the Location.
Gets or sets the ScopingMethod.
Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 469
Ansys.ACT.Automation.Mechanical Namespace

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 166: Members

Property Area (p. 471) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 471)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
470 of ANSYS, Inc. and its subsidiaries and affiliates.
 ICrossSection

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 471) Gets the internal object. For advanced usage
only.
Property IYY (p. 471) Gets the IYY.
Property IZZ (p. 472) Gets the IZZ.
Property Thick1 (p. 472) Gets or sets the Thick1.
Property Thick2 (p. 472) Gets or sets the Thick2.
Property Thick3 (p. 472) Gets or sets the Thick3.
Property Width1 (p. 472) Gets or sets the Width1.
Property Width2 (p. 472) Gets or sets the Width2.
Property Width3 (p. 473) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 471
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
472 of ANSYS, Inc. and its subsidiaries and affiliates.
 Image

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 167: Members

Property Children (p. 473) Gets the list of children.

Property Comments (p. 473) Gets the list of associated comments.
Property DataModelObjectCategory (p. 474) Gets the current DataModelObject's category.
Property Images (p. 474) Gets the list of associated images.
Property InternalObject (p. 474) Gets the internal object. For advanced usage only.
Method AddComment() (p. 474) Creates a new child Comment.
Method AddImage(string) (p. 474) 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. 475) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 475)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 475)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 473
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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
474 of ANSYS, Inc. and its subsidiaries and affiliates.
 Image

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 475
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.)

ImagePlane
Defines a ImagePlane.

Declaration Syntax
public class ImagePlane : DataModelObject, IFolderDataModelObject

Table 168: Members

Property Children (p. 477) Gets the list of children.

Property Comments (p. 477) Gets the list of associated comments.
Property CoordinateSystem (p. 477) 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. 477) Gets or sets whether the annotation for the image’s
coordinate system is rendered.
Property DataModelObjectCategory (p. 478) Gets the current DataModelObject's category.
Property FlipHorizontally (p. 478) Gets or sets whether the rendered image on the
plane should be flipped horizontally.
Property FlipVertically (p. 478) Gets or sets whether the rendered image on the
plane should be flipped vertically.
Property Height (p. 478) Gets or sets the physical height of the image plane.
Property ImageFilePath (p. 478) Gets the file path for the rendered image.
Property Images (p. 478) Gets the list of associated images.
Property InternalObject (p. 479) Gets the internal object. For advanced usage only.
Property PixelHeight (p. 479) Gets the pixel height of the plane's image.
Property PixelWidth (p. 479) Gets the pixel width of the plane's image.
Property ShowAlways (p. 479) Gets or sets whether the image plane will be shown
independent of the active object in the tree.
Property Translucency (p. 479) Gets or sets the translucency of the plane, as a
percentage ranging from 0 to 100.
Property Width (p. 479) Gets or sets the physical width of the image plane.
Method AddComment() (p. 480) Creates a new child Comment.
Method Delete() (p. 480) Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
476 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImagePlane

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.

IList<ChildrenType>) (p. 480)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 480)
Method Import(string) (p. 481) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImagePlane

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 479
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
480 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedBoltPretensions

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 169: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 481
Ansys.ACT.Automation.Mechanical Namespace

Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 482)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 482) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
482 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedCondensedPart

Declaration Syntax
public class ImportedCondensedPart : CondensedPartBase

Table 170: Members

Property ActualNodeOffset (p. 486) Gets the

ActualNodeOffset.
Property Children (p. 258) Gets the list of
children.

(Inherited from
CondensedPartBase (p. 257).)
Property Comments (p. 258) Gets the list of
associated comments.

(Inherited from
CondensedPartBase (p. 257).)
Property CondensedPartFileName (p. 486) Gets or sets the
CondensedPartFileName.
Property CondensedPartUnitSystem (p. 486) Gets or sets the
CondensedPartUnitSystem.
Property CoordinateSystem (p. 486) Gets or sets the
CoordinateSystem.
Property DataModelObjectCategory (p. 486) Gets the current
DataModelObject's
category.
Property Figures (p. 258) Gets the list of
associated figures.

(Inherited from
CondensedPartBase (p. 257).)
Property GeometrySelection (p. 259) Gets or sets the
GeometrySelection.

(Inherited from
CondensedPartBase (p. 257).)
Property Images (p. 259) Gets the list of
associated images.

(Inherited from
CondensedPartBase (p. 257).)
Property ImportFileFormat (p. 486) Gets or sets the
ImportFileFormat.
Property ImportStatus (p. 487) Gets the
ImportStatus.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 483
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 487) Gets the internal

object. For advanced
usage only.
Property NodeOffset (p. 487) Gets or sets the
NodeOffset.
Property NumberInterfaceEntries (p. 259) Gets the
NumberInterfaceEntries.

(Inherited from
CondensedPartBase (p. 257).)
Property NumberMasterNodes (p. 259) Gets the
NumberMasterNodes.

(Inherited from
CondensedPartBase (p. 257).)
Property Physics (p. 259) Gets the Physics.

(Inherited from
CondensedPartBase (p. 257).)
Property ReferenceTemperature (p. 260) Gets or sets the
ReferenceTemperature.

(Inherited from
CondensedPartBase (p. 257).)
Property SolutionName (p. 260) Gets or sets the
SolutionName.

(Inherited from
CondensedPartBase (p. 257).)
Property SolutionNameMode (p. 260) Gets or sets the
SolutionNameMode.

(Inherited from
CondensedPartBase (p. 257).)
Property SolverFilesDirectory (p. 260) Gets the
SolverFilesDirectory.

(Inherited from
CondensedPartBase (p. 257).)
Property SolverUnits (p. 260) Gets or sets the
SolverUnits.

(Inherited from
CondensedPartBase (p. 257).)
Property SolverUnitSystem (p. 260) Gets or sets the
SolverUnitSystem.

(Inherited from
CondensedPartBase (p. 257).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
484 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedCondensedPart

Property Suppressed (p. 261) Gets or sets the

Suppressed.

(Inherited from
CondensedPartBase (p. 257).)
Property TemperatureUnits (p. 261) Gets the
TemperatureUnits.

(Inherited from
CondensedPartBase (p. 257).)
Method CreateJointFromNodeIds(IEnumerable<int>) (p. 487) Create a Joint with
the provided node
IDs.
Method CreateJoints(IEnumerable<int>) (p. 487) Creates Joints
corresponding to the
provided interface ID
Numbers.
Method CreateNodalNamedSelectionFromNodeIds(IEnumerable<int>) (p. 488) Create a Nodal
Named Selection with
the provided node
IDs.
Method CreateNodalNamedSelections(IEnumerable<int>) (p. 488) Creates Nodal Named
Selections
corresponding to the
provided interface ID
Numbers.
Method CreateRemotePointFromNodeIds(IEnumerable<int>) (p. 488) Create a Remote
Point with the
provided node IDs.
Method CreateRemotePoints(IEnumerable<int>) (p. 489) Creates Remote
Points corresponding
to the provided
interface ID Numbers.
Method GetOriginalNodeCoordinates() (p. 489) Get all the Node
Locations of the
Original Interfaces
Data table.
Method GetTransformedNodeCoordinates() (p. 489) Get all the Node
Locations of the
Transformed
Interfaces Data table.
Method ImportCondensedPart() (p. 489) Run the Import
Condensed Part
action.
Method ReadInterfaceData() (p. 489) Run the Read
Interface Data action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 485
Ansys.ACT.Automation.Mechanical Namespace

Method UpdateNodeLocation(int, Quantity, Quantity, Quantity, Quantity, Update Node

Quantity, Quantity) (p. 490) 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; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

ImportFileFormat
Gets or sets the ImportFileFormat.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
486 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedCondensedPart

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 487
Ansys.ACT.Automation.Mechanical Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
488 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedCondensedPart

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 489
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
490 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedConstraintEquations

Declaration Syntax
public class ImportedConstraintEquations : ExternalModelDataColl

Table 171: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 491)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 491) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 491
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedContacts
Defines a ImportedContacts.

Declaration Syntax
public class ImportedContacts : ExternalModelDataColl

Table 172: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 492)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 493) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
492 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedCoordinateSystems

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 173: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 494)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 494) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 493
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 372).)

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.

Declaration Syntax
public class ImportedElementOrientations : ExternalModelDataColl

Table 174: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 495)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
494 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedFlexibleRemoteConnectors

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 495) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

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; }

ImportedFlexibleRemoteConnectors
Defines a ImportedFlexibleRemoteConnectors.

Declaration Syntax
public class ImportedFlexibleRemoteConnectors : ExternalModelDataColl

Table 175: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 495
Ansys.ACT.Automation.Mechanical Namespace

Property DataModelObjectCategory (p. 496)Gets the current DataModelObject's

category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 496) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

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; }

ImportedLayeredSection
Defines a ImportedLayeredSection.

Declaration Syntax
public class ImportedLayeredSection : ExternalEnhancedModel

Table 176: Members

Property Children (p. 368) Gets the list of children.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Comments (p. 368) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
496 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedLayeredSection

(Inherited from
ExternalEnhancedModel (p. 368).)
Property DataModelObjectCategory (p. 497) Gets the current DataModelObject's
category.
Property Figures (p. 369) Gets the list of associated figures.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Images (p. 369) Gets the list of associated images.

Property InternalObject (p. 498)
Property LayerToDisplay (p. 369)
(Inherited from
ExternalEnhancedModel (p. 368).)
Gets the internal object. For advanced usage
only.
Gets or sets the LayerToDisplay.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property MaximumNumberOfLayers (p. 369) Gets the MaximumNumberOfLayers.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property NonlinearEffects (p. 370) Gets or sets the NonlinearEffects.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Suppressed (p. 370) Gets or sets the Suppressed.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property ThermalStrainEffects (p. 370) Gets or sets the ThermalStrainEffects.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Type (p. 370) Gets the Type.

(Inherited from
ExternalEnhancedModel (p. 368).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 497
Ansys.ACT.Automation.Mechanical Namespace

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 177: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 499)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 499) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
498 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedObject

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.

Declaration Syntax
public class ImportedObject

Table 178: Members

Property Active (p. 499) This property sets the object to active or inactive
status
Property InternalObject (p. 499) Gets the internal object. For advanced usage only.
Method GetPropertyNames() (p. 500) This method gives the complete list of property
names that are supported.
Method GetPropertyValueAsString(string) (p. 500) Data in string format that is present on the
columns
Method SetPropertyValue(string, object) (p. 500) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 499
Ansys.ACT.Automation.Mechanical Namespace

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
500 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedPlies

Declaration Syntax
public class ImportedPlies : ExternalEnhancedModel

Table 179: Members

Property Children (p. 368) Gets the list of children.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Comments (p. 368) Gets the list of associated comments.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property DataModelObjectCategory (p. 502) Gets the current DataModelObject's
category.
Property Figures (p. 369) Gets the list of associated figures.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Images (p. 369) Gets the list of associated images.

Property InternalObject (p. 502)
Property LayerToDisplay (p. 369)
(Inherited from
ExternalEnhancedModel (p. 368).)
Gets the internal object. For advanced usage
only.
Gets or sets the LayerToDisplay.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property MaximumNumberOfLayers (p. 369) Gets the MaximumNumberOfLayers.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property NonlinearEffects (p. 370) Gets or sets the NonlinearEffects.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Suppressed (p. 370) Gets or sets the Suppressed.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property ThermalStrainEffects (p. 370) Gets or sets the ThermalStrainEffects.

(Inherited from
ExternalEnhancedModel (p. 368).)
Property Type (p. 370) Gets the Type.

(Inherited from
ExternalEnhancedModel (p. 368).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 501
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 IDSExternalEnhancedModelAuto InternalObject { get; }

ImportedPliesCollection
Defines a ImportedPliesCollection.

Declaration Syntax
public class ImportedPliesCollection : ImportedDataModelObject, IFolderDataModelObject

Table 180: Members

Property Children (p. 502) Gets the list of children.

Property Comments (p. 503) Gets the list of associated comments.
Property DataModelObjectCategory (p. 503) Gets the current DataModelObject's category.
Property Figures (p. 503) Gets the list of associated figures.
Property Images (p. 503) Gets the list of associated images.
Property InternalObject (p. 503) Gets the internal object. For advanced usage only.
Method AddComment() (p. 503) Creates a new child Comment.
Method AddFigure() (p. 504) Creates a new child Figure.
Method AddImage(string) (p. 504) 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. 504)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 505)

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
502 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedPliesCollection

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 IDSImportedPliesCollectionAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Release 2022 R2 - © 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 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.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
504 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedPointMasses

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.)

ImportedPointMasses
Defines a ImportedPointMasses.

Declaration Syntax
public class ImportedPointMasses : ExternalModelDataColl

Table 181: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 506)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 505
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 506) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

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; }

ImportedPremeshedBoltPretensions
Defines a ImportedPremeshedBoltPretensions.

Declaration Syntax
public class ImportedPremeshedBoltPretensions : ExternalModelDataColl

Table 182: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
506 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedRigidRemoteConnectors

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 507)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 507) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

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 183: Members

Property Children (p. 373) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 507
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 508)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 508) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
508 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedShellThicknesses

Declaration Syntax
public class ImportedShellThicknesses : ExternalModelDataColl

Table 184: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 509)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 509) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 509
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSExternalModelDataCollAuto InternalObject { get; }

ImportedSpringConnectors
Defines a ImportedSpringConnectors.

Declaration Syntax
public class ImportedSpringConnectors : ExternalModelDataColl

Table 185: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 510)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 511) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

(Inherited from
ExternalModelDataColl (p. 372).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
510 of ANSYS, Inc. and its subsidiaries and affiliates.
 ImportedStresses

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 186: Members

Property Children (p. 373) Gets the list of children.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Comments (p. 373) Gets the list of associated comments.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Count (p. 373) Gets the NumberOfRows.

(Inherited from
ExternalModelDataColl (p. 372).)
Property DataModelObjectCategory (p. 512)Gets the current DataModelObject's
category.
Property Figures (p. 373) Gets the list of associated figures.

(Inherited from
ExternalModelDataColl (p. 372).)
Property Images (p. 374) Gets the list of associated images.

(Inherited from
ExternalModelDataColl (p. 372).)
Property InternalObject (p. 512) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 374) Gets or sets the Suppressed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 511
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
ExternalModelDataColl (p. 372).)

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.

Declaration Syntax
public class InitialCondition : DataModelObject, IFolderDataModelObject

Table 187: Members

Property Children (p. 514) Gets the list of children.

Property Comments (p. 514) Gets the list of associated comments.
Property ContactStatus (p. 514) Gets or sets the ContactStatus.
Property CoordinateSystem (p. 515) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 515) Gets the current DataModelObject's
category.
Property DefineBy (p. 515) Gets or sets the DefineBy.
Property Direction (p. 515) Gets or sets the Direction.
Property DropDirection (p. 515) Gets or sets the DropDirection.
Property DropHeight (p. 515) Gets or sets the DropHeight.
Property DropTestDefineBy (p. 516) Gets or sets the DropTestDefineBy.
Property ExplicitPreStressTime (p. 516) Gets or sets the ExplicitPreStressTime.
Property Figures (p. 516) Gets the list of associated figures.
Property Images (p. 516) Gets the list of associated images.
Property ImpactVelocity (p. 516) Gets or sets the ImpactVelocity.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
512 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialCondition

Property InitialEnvironment (p. 516) Gets or sets the InitialEnvironment.

Property InitialTemperature (p. 517) Gets the InitialTemperature.
Property InitialTemperatureValue (p. 517) Gets or sets the
InitialTemperatureValue.
Property InputType (p. 517) Gets or sets the InputType.
Property InternalObject (p. 517) Gets the internal object. For advanced
usage only.
Property LoadControl (p. 517) Gets or sets the LoadControl.
Property Location (p. 517) Gets or sets the Location.
Property ModalEnvironmentHarmonicIC ***OBSOLETE*** Gets or sets the
Use 'ModalICEnvironment' property ModalEnvironmentHarmonicIC.
instead. (p. 518)
Property ModalEnvironmentPSDIC ***OBSOLETE*** Use Gets or sets the
'ModalICEnvironment' property instead. (p. 518) ModalEnvironmentPSDIC.
Property ModalEnvironmentRSIC ***OBSOLETE*** Use Gets or sets the
'ModalICEnvironment' property instead. (p. 518) ModalEnvironmentRSIC.
Property ModalEnvironmentTransientMSUPIC Gets or sets the
***OBSOLETE*** Use 'ModalICEnvironment' ModalEnvironmentTransientMSUPIC.
property instead. (p. 518)
Property ModalICEnvironment (p. 518) Gets or sets the ModalICEnvironment.
Property Mode (p. 519) Gets or sets the Mode.
Property NewtonRaphsonOption (p. 519) Gets the NewtonRaphsonOption.
Property PressureInitialization (p. 519) Gets or sets the PressureInitialization.
Property PreStressDefineBy (p. 519) Gets or sets the PreStressDefineBy.
Property PreStressEnvironmentHarmonicIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentHarmonicIC.
instead. (p. 519)
Property PreStressEnvironmentHarmonicMSUPModal (p. 519) Gets the
PreStressEnvironmentHarmonicMSUPModal.
Property PreStressEnvironmentModalIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentModalIC.
instead. (p. 520)
Property PreStressEnvironmentTransientIC ***OBSOLETE*** Gets or sets the
Use 'PreStressICEnvironment' property PreStressEnvironmentTransientIC.
instead. (p. 520)
Property PreStressEnvironmentTransientMSUPModal (p. 520) Gets the
PreStressEnvironmentTransientMSUPModal.
Property PreStressICEnvironment (p. 520) Gets or sets the
PreStressICEnvironment.
Property PreStressLoadStep (p. 520) Gets or sets the PreStressLoadStep.
Property PreStressTime (p. 520) Gets or sets the PreStressTime.
Property ReferenceTemperature (p. 521) Gets or sets the
ReferenceTemperature.

Release 2022 R2 - © 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 ReportedLoadStep (p. 521) Gets the ReportedLoadStep.

Property ReportedSubStep (p. 521) Gets the ReportedSubStep.
Property ReportedTime (p. 521) Gets the ReportedTime.
Property Suppressed (p. 521) Gets or sets the Suppressed.
Property Time (p. 521) Gets or sets the Time.
Property TimeStepFactor (p. 522) Gets or sets the TimeStepFactor.
Property TotalMagnitude (p. 522) Gets or sets the Magnitude.
Property XComponent (p. 522) Gets or sets the XComponent.
Property YComponent (p. 522) Gets or sets the YComponent.
Property ZComponent (p. 522) Gets or sets the ZComponent.
Method AddCommandSnippet() (p. 522) Creates a new child
CommandSnippet.
Method AddComment() (p. 523) Creates a new child Comment.
Method AddFigure() (p. 523) Creates a new child Figure.
Method AddImage(string) (p. 523) 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. 523) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 523) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 524) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
514 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialCondition

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.

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.

Release 2022 R2 - © 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 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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
516 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialCondition

Declaration Syntax
public Analysis InitialEnvironment { set;get; }

InitialTemperature
Gets the InitialTemperature.

Declaration Syntax
public InitialTemperatureType InitialTemperature { get; }

InitialTemperatureValue
Gets or sets the InitialTemperatureValue.

Declaration Syntax
public Quantity InitialTemperatureValue { set;get; }

InputType
Gets or sets the InputType.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 517
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
518 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialCondition

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 519
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
520 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialCondition

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 521
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
522 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialCondition

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 523
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.)

InitialConditions
Defines a InitialConditions.

Declaration Syntax
public class InitialConditions : DataModelObject, IFolderDataModelObject

Table 188: Members

Property Children (p. 525) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
524 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialConditions

Property Comments (p. 525) Gets the list of associated comments.

Property DataModelObjectCategory (p. 525) Gets the current DataModelObject's category.
Property Figures (p. 526) Gets the list of associated figures.
Property Images (p. 526) Gets the list of associated images.
Property InternalObject (p. 526) Gets the internal object. For advanced usage only.
Method AddComment() (p. 526) Creates a new child Comment.
Method AddFigure() (p. 526) Creates a new child Figure.
Method AddImage(string) (p. 526) 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. 527)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 527)
Method InsertAngularVelocity() (p. 528) Creates a new Angular Velocity
Method InsertDropHeight() (p. 528) Creates a new Drop Height
Method InsertVelocity() (p. 528) 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 525
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 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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
526 of ANSYS, Inc. and its subsidiaries and affiliates.
 InitialConditions

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 527
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual InitialCondition InsertVelocity()

InterfaceDelamination
Defines a InterfaceDelamination.

Declaration Syntax
public class InterfaceDelamination : GenericDelamination

Table 189: Members

Property AutomaticTimeStepping (p. 529) Gets or sets the AutomaticTimeStepping.

Property Children (p. 421) Gets the list of children.

(Inherited from GenericDelamination (p. 421).)

Property Comments (p. 422) Gets the list of associated comments.

(Inherited from GenericDelamination (p. 421).)

Property CriticalRate (p. 529) Gets or sets the CriticalRate.
Property DataModelObjectCategory (p. 529) Gets the current DataModelObject's
category.
Property DistanceTolerance (p. 530) Gets or sets the DistanceTolerance.
Property FailureCriteriaOption (p. 530) Gets or sets the FailureCriteriaOption.
Property Figures (p. 422) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
528 of ANSYS, Inc. and its subsidiaries and affiliates.
 InterfaceDelamination

(Inherited from GenericDelamination (p. 421).)

Property GenerationMethod (p. 530) Gets or sets the GenerationMethod.
Property Images (p. 422) Gets the list of associated images.

(Inherited from GenericDelamination (p. 421).)

Property InitialCrack (p. 530)
Property InitialTimeStep (p. 530)
Property InternalObject (p. 530)
Property MatchControl (p. 531)
Property Material (p. 531)
Property MaximumTimeStep (p. 531)
Property Method (p. 531)
Property MinimumTimeStep (p. 531)
Property SourceLocation (p. 531)
Property Suppressed (p. 532)
Property TargetLocation (p. 532)
Property ToleranceType (p. 532)
Property Type (p. 532)
Gets or sets the InitialCrack.
Gets or sets the InitialTimeStep.
Gets the internal object. For advanced usage
only.
Gets or sets the MatchControl.
Gets or sets the Material.
Gets or sets the MaximumTimeStep.
Gets or sets the Method.
Gets or sets the MinimumTimeStep.
Gets or sets the SourceLocation.
Gets or sets the Suppressed.
Gets or sets the TargetLocation.
Gets or sets the ToleranceType.
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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 529
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
530 of ANSYS, Inc. and its subsidiaries and affiliates.
 InterfaceDelamination

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 531
Ansys.ACT.Automation.Mechanical Namespace

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.

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 190: Members

Method GetBushingDampingPerThetaUnitX(int) (p. 534) Gets the Coefficient for the damping per
ThetaUnitX at the indicated row index.
Method GetBushingDampingPerThetaUnitY(int) (p. 534) Gets the Coefficient for the damping per
ThetaUnitY at the indicated row index.
Method GetBushingDampingPerThetaUnitZ(int) (p. 534) Gets the Coefficient for the damping per
ThetaUnitZ at the indicated row index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
532 of ANSYS, Inc. and its subsidiaries and affiliates.
 JointBushingWorksheet

Method GetBushingDampingPerUnitX(int) (p. 534) Gets the Coefficient for the damping per
UnitX at the indicated row index.
Method GetBushingDampingPerUnitY(int) (p. 535) Gets the Coefficient for the damping per
UnitY at the indicated row index.
Method GetBushingDampingPerUnitZ(int) (p. 535) Gets the Coefficient for the damping per
UnitZ at the indicated row index.
Method GetBushingStiffnessPerThetaUnitX(int) (p. 535) Gets the Coefficient for the stiffness per
ThetaUnitX at the indicated row index.
Method GetBushingStiffnessPerThetaUnitY(int) (p. 536) Gets the Coefficient for the stiffness per
ThetaUnitY at the indicated row index.
Method GetBushingStiffnessPerThetaUnitZ(int) (p. 536) Gets the Coefficient for the stiffness per
ThetaUnitZ at the indicated row index.
Method GetBushingStiffnessPerUnitX(int) (p. 536) Gets the Coefficient for the stiffness per
UnitX at the indicated row index.
Method GetBushingStiffnessPerUnitY(int) (p. 536) Gets the Coefficient for the stiffness per
UnitY at the indicated row index.
Method GetBushingStiffnessPerUnitZ(int) (p. 537) Gets the Coefficient for the stiffness per
UnitZ at the indicated row index.
Method SetBushingDampingPerThetaUnitX(int, Sets the Coefficient for the damping per
double) (p. 537) ThetaUnitX at the indicated row index.
Method SetBushingDampingPerThetaUnitY(int, Sets the Coefficient for the damping per
double) (p. 537) ThetaUnitY at the indicated row index.
Method SetBushingDampingPerThetaUnitZ(int, Sets the Coefficient for the damping per
double) (p. 538) ThetaUnitZ at the indicated row index.
Method SetBushingDampingPerUnitX(int, Sets the Coefficient for the damping per
double) (p. 538) UnitX at the indicated row index.
Method SetBushingDampingPerUnitY(int, Sets the Coefficient for the damping per
double) (p. 538) UnitY at the indicated row index.
Method SetBushingDampingPerUnitZ(int, Sets the Coefficient for the damping per
double) (p. 539) UnitZ at the indicated row index.
Method SetBushingStiffnessPerThetaUnitX(int, Sets the Coefficient for the stiffness per
double) (p. 539) ThetaUnitX at the indicated row index.
Method SetBushingStiffnessPerThetaUnitY(int, Sets the Coefficient for the stiffness per
double) (p. 540) ThetaUnitY at the indicated row index.
Method SetBushingStiffnessPerThetaUnitZ(int, Sets the Coefficient for the stiffness per
double) (p. 540) ThetaUnitZ at the indicated row index.
Method SetBushingStiffnessPerUnitX(int, Sets the Coefficient for the stiffness per UnitX
double) (p. 540) at the indicated row index.
Method SetBushingStiffnessPerUnitY(int, Sets the Coefficient for the stiffness per UnitY
double) (p. 541) at the indicated row index.
Method SetBushingStiffnessPerUnitZ(int, Sets the Coefficient for the stiffness per UnitZ
double) (p. 541) at the indicated row index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 533
Ansys.ACT.Automation.Mechanical Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
534 of ANSYS, Inc. and its subsidiaries and affiliates.
 JointBushingWorksheet

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 535
Ansys.ACT.Automation.Mechanical Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
536 of ANSYS, Inc. and its subsidiaries and affiliates.
 JointBushingWorksheet

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 537
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
538 of ANSYS, Inc. and its subsidiaries and affiliates.
 JointBushingWorksheet

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 539
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
540 of ANSYS, Inc. and its subsidiaries and affiliates.
 LayeredSection

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 541
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class LayeredSection : DataModelObject, IFolderDataModelObject

Table 191: Members

Property Children (p. 542) Gets the list of children.

Property Comments (p. 543) Gets the list of associated comments.
Property CoordinateSystem (p. 543) Gets or sets the CoordinateSystem. Accepts/Returns
None for Body Coordinate System
Property DataModelObjectCategory (p. 543) Gets the current DataModelObject's category.
Property Figures (p. 543) Gets the list of associated figures.
Property Images (p. 543) Gets the list of associated images.
Property InternalObject (p. 543) Gets the internal object. For advanced usage only.
Property LayeredSectionMembraneOffset (p. 544) Gets or sets the LayeredSectionMembraneOffset.
Property Layers (p. 544) Returns the Layers worksheet associated with
LayeredSection
Property LayerToDisplay (p. 544) Gets or sets the LayerToDisplay.
Property Location (p. 544) Gets or sets the Location.
Property NonlinearEffects (p. 544) Gets or sets the NonlinearEffects.
Property OffsetType (p. 544) Gets or sets the OffsetType.
Property Suppressed (p. 545) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 545) Gets or sets the ThermalStrainEffects.
Property TotalMass (p. 545) Gets the TotalMass.
Property TotalThickness (p. 545) Gets the TotalThickness.
Method AddComment() (p. 545) Creates a new child Comment.
Method AddFigure() (p. 545) Creates a new child Figure.
Method AddImage(string) (p. 546) 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. 546) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 546)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 546)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
542 of ANSYS, Inc. and its subsidiaries and affiliates.
 LayeredSection

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 543
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
544 of ANSYS, Inc. and its subsidiaries and affiliates.
 LayeredSection

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; }

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 545
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
546 of ANSYS, Inc. and its subsidiaries and affiliates.
 LayeredSectionWorksheet

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.

Declaration Syntax
public class LayeredSectionWorksheet : Worksheet

Table 192: Members

Property RowCount (p. 548)
Method AddThicknessLayer(string,
double, double) (p. 548)
Method DeleteRow(int) (p. 549)
Method GetAngle(int) (p. 549)
Method GetMaterial(int) (p. 549)
Method GetThickness(int) (p. 549)
Method InsertThicknessLayerAbove(string, Insert a new layer to the LayeredSectionWorksheet The
double, double, int) (p. 550)
Gets the number of entries (rows) in the worksheet.
Add a row to the LayeredSectionWorksheet New layers
are added as the top most layer in the Z direction.
LayeredSectionWorksheet indices are zero based and
ordered in the Z direction.
Delete a row from the LayeredSectionWorksheet
LayeredSectionWorksheet indices are zero based and
ordered in the Z direction.
Gets the angle for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.
Gets the material for the LayeredSection at the row index
specifiied. LayeredSectionWorksheet indices are zero
based and ordered in the Z direction.
Gets the thickness for the LayeredSection at the row
index specifiied. LayeredSectionWorksheet indices are
zero based and ordered in the Z direction.
new layer will be inserted above the layer indicated by

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 547
Ansys.ACT.Automation.Mechanical Namespace

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. 550) 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. 551) 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. 551) 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. 552) 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; }

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
548 of ANSYS, Inc. and its subsidiaries and affiliates.
 LayeredSectionWorksheet

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 549
Ansys.ACT.Automation.Mechanical Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
550 of ANSYS, Inc. and its subsidiaries and affiliates.
 LayeredSectionWorksheet

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.

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 551
Ansys.ACT.Automation.Mechanical Namespace

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

LCrossSection
Defines a LCrossSection.

Declaration Syntax
public class LCrossSection : CrossSection

Table 193: Members

Property Area (p. 553) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 553)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
552 of ANSYS, Inc. and its subsidiaries and affiliates.
 LCrossSection

Property InternalObject (p. 553) Gets the internal object. For advanced usage
only.
Property IYY (p. 553) Gets the IYY.
Property IZZ (p. 553) Gets the IZZ.
Property Thick1 (p. 554) Gets or sets the Thick1.
Property Thick2 (p. 554) Gets or sets the Thick2.
Property Width1 (p. 554) Gets or sets the Width1.
Property Width2 (p. 554) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 553
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public Quantity Width1 { set;get; }

Width2
Gets or sets the Width2.

Declaration Syntax
public Quantity Width2 { set;get; }

LocalVonMisesStressConstraint
Defines a LocalVonMisesStressConstraint.

Declaration Syntax
public class LocalVonMisesStressConstraint : ResponseConstraint

Table 194: Members

Property Children (p. 809) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
554 of ANSYS, Inc. and its subsidiaries and affiliates.
 LocalVonMisesStressConstraint

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 555)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 555) Gets the internal object. For advanced usage only.
Property Location (p. 555) Gets or sets the Location.
Property Maximum (p. 555) Gets or sets the Maximum.
Property ScopingMethod (p. 556) Gets or sets the ScopingMethod.
Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 555
Ansys.ACT.Automation.Mechanical Namespace

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

ManufacturingConstraint
Defines a ManufacturingConstraint.

Defines a ManufacturingConstraint.

Declaration Syntax
public abstract class ManufacturingConstraint : DataModelObject, IFolderDataModelObject

Table 195: Members

Property Children (p. 556) Gets the list of children.

Property DataModelObjectCategory (p. 556) Gets the current DataModelObject's
category.
Property InternalObject (p. 557) Gets the internal object. For advanced
usage only.
Property Selection (p. 557) Gets or sets the Selection.
Property Suppressed (p. 557) Gets or sets the Suppressed.
Method Delete() (p. 557) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 557)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 558)
Method RenameBasedOnDefinition() (p. 558) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
556 of ANSYS, Inc. and its subsidiaries and affiliates.
 ManufacturingConstraint

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 557
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()

MappingValidation
Defines a MappingValidation.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
558 of ANSYS, Inc. and its subsidiaries and affiliates.
 MappingValidation

Declaration Syntax
public class MappingValidation : DataModelObject, IFolderDataModelObject

Table 196: Members

Property ActiveSequence (p. 560) Gets or sets the ActiveSequence.

Property ActiveSequenceByValue (p. 560) Gets or sets the ActiveSequenceByValue.
Property BoundingTolerance (p. 560) Gets or sets the BoundingTolerance.
Property Children (p. 560) Gets the list of children.
Property Comments (p. 560) Gets the list of associated comments.
Property ComplexComponent (p. 560) Gets or sets the ComplexComponent.
Property Component (p. 561) Gets or sets the Component.
Property DataModelObjectCategory (p. 561) Gets the current DataModelObject's category.
Property DefineActiveSequenceBy (p. 561) Control whether the active sequenced is defined
by row or by value.
Property Display (p. 561) No details are provided for this entry.
Property DisplayDataType (p. 561) Gets or sets the DisplayDataType.
Property Figures (p. 561) Gets the list of associated figures.
Property FileIdentifierIndex (p. 562) Gets or sets the FileIdentifierIndex.
Property Images (p. 562) Gets the list of associated images.
Property InternalObject (p. 562) Gets the internal object. For advanced usage only.
Property IsolineThickness (p. 562) No details are provided for this entry.
Property IsolineType (p. 562) No details are provided for this entry.
Property Layer (p. 562) Gets or sets the Layer.
Property LegendDivisions (p. 563) No details are provided for this entry.
Property Scale (p. 563) No details are provided for this entry.
Property ShellFace (p. 563) Controls whether the displayed shell face lies on
the bottom, middle, or top of the shell.
Property Type (p. 563) No details are provided for this entry.
Method AddComment() (p. 563) Creates a new child Comment.
Method AddFigure() (p. 563) Creates a new child Figure.
Method AddImage(string) (p. 564) 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. 564) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 564)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 564)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 559
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
560 of ANSYS, Inc. and its subsidiaries and affiliates.
 MappingValidation

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 561
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
562 of ANSYS, Inc. and its subsidiaries and affiliates.
 MappingValidation

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; }

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 563
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
564 of ANSYS, Inc. and its subsidiaries and affiliates.
 MassConstraint

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.

Declaration Syntax
public class MassConstraint : ResponseConstraint

Table 197: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 566) Gets the current DataModelObject's category.
Property DefineBy (p. 566) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 566)
Property Location (p. 566)
Property MaximumAbsoluteValue (p. 566)
Property MinimumAbsoluteValue (p. 566)
Property PercentageToRetain (p. 567)
Property PercentageToRetainMax (p. 567)
Property PercentageToRetainMin (p. 567)
Property ScopingMethod (p. 567)
Gets the internal object. For advanced usage only.
Gets or sets the Location.
Gets or sets the MaximumAbsoluteValue.
Gets or sets the MinimumAbsoluteValue.
Gets or sets the PercentageToRetain.
Gets or sets the PercentageToRetainMax.
Gets or sets the PercentageToRetainMin.
Gets or sets the ScopingMethod.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 565
Ansys.ACT.Automation.Mechanical Namespace

Property Selection (p. 567) Gets or sets the Selection.

Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
566 of ANSYS, Inc. and its subsidiaries and affiliates.
 Material

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 567
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class Material : DataModelObject, IFolderDataModelObject

Table 198: Members

Property AssignedBodies (p. 568) Gets the AssignedBodies.

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.
Method AddComment() (p. 569) 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 AddMaterialAssignment() (p. 570) Run the AddMaterialAssignment action.
Method CreateMaterialAssignment() Run the CreateMaterialAssignment action.
***OBSOLETE*** Use
'AddMaterialAssignment'
instead (p. 570)
Method GetAsDictionary() (p. 570) Returns material as a python dictionary
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)

AssignedBodies
Gets the AssignedBodies.

Declaration Syntax
public int AssignedBodies { get; }

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
568 of ANSYS, Inc. and its subsidiaries and affiliates.
 Material

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 IDSMaterialAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 569
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.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
570 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaterialAssignment

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.)

MaterialAssignment
Defines a MaterialAssignment.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 571
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public class MaterialAssignment : ImportedDataModelObject, IFolderDataModelObject

Table 199: Members

Property Children (p. 572) Gets the list of children.

Property Comments (p. 573) Gets the list of associated comments.
Property DataModelObjectCategory (p. 573) Gets the current DataModelObject's category.
Property FieldCoordinateSystem (p. 573) Gets or sets the FieldCoordinateSystem.
Property Figures (p. 573) Gets the list of associated figures.
Property Images (p. 573) Gets the list of associated images.
Property InternalObject (p. 573) Gets the internal object. For advanced usage only.
Property Location (p. 574) Gets or sets the Location.
Property Material (p. 574) Gets or sets the Material.
Property MaterialName ***OBSOLETE*** Use Gets or sets the MaterialName.
'Material' property instead. (p. 574)
Property NonlinearEffects (p. 574) Gets or sets the NonlinearEffects.
Property ReferenceTemperatureValue (p. 574) Gets or sets the ReferenceTemperatureValue.
Property Suppressed (p. 574) Gets or sets the Suppressed.
Property ThermalStrainEffects (p. 575) Gets or sets the ThermalStrainEffects.
Property UseReferenceTemperatureByBody (p. 575) Gets or sets the UseReferenceTemperatureByBody.
Method AddCommandSnippet() (p. 575) Creates a new CommandSnippet
Method AddComment() (p. 575) Creates a new child Comment.
Method AddFigure() (p. 575) Creates a new child Figure.
Method AddImage(string) (p. 575) 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. 576) Run the CreateMaterialPlot action.
Method Delete() (p. 576) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 576)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 576)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
572 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaterialAssignment

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 573
Ansys.ACT.Automation.Mechanical Namespace

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; }

MaterialName ***OBSOLETE*** Use 'Material' property instead.

Gets or sets the MaterialName.

Declaration Syntax
public string MaterialName { 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
574 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaterialAssignment

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 575
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
576 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaterialPlot

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 200: Members

Property Children (p. 578) Gets the list of children.

Property DataModelObjectCategory (p. 578) Gets the current DataModelObject's
category.
Property InternalObject (p. 578) Gets the internal object. For advanced
usage only.
Property Location (p. 578) Gets or sets the Location.
Property MaterialProperty (p. 578) Gets or sets the MaterialProperty.
Property MaterialPropertyComponent (p. 578) Gets or sets the
MaterialPropertyComponent.
Property Suppressed (p. 579) Gets or sets the Suppressed.
Method Clear() (p. 579) Run the Clear action.
Method Delete() (p. 579) Run the Delete action.
Method Generate() (p. 579) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 579)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 580)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 577
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
578 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaterialPlot

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 579
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.)

Materials
Defines a Materials.

Declaration Syntax
public class Materials : ImportedDataModelObject, IFolderDataModelObject

Table 201: Members

Property Children (p. 581) Gets the list of children.

Property Comments (p. 581) Gets the list of associated comments.
Property DataModelObjectCategory (p. 581) Gets the current DataModelObject's category.
Property Figures (p. 581) Gets the list of associated figures.
Property Images (p. 582) Gets the list of associated images.
Property InternalObject (p. 582) Gets the internal object. For advanced usage only.
Property MaterialAssignments (p. 582) Gets the MaterialAssignments.
Property MaterialCount (p. 582) Gets the MaterialCount.
Method AddComment() (p. 582) Creates a new child Comment.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
580 of ANSYS, Inc. and its subsidiaries and affiliates.
 Materials

Method AddFigure() (p. 582) Creates a new child Figure.

Method AddImage(string) (p. 583) 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. 583) Creates a new MaterialAssignment
Method AddMaterialCombination() (p. 583) Creates a new MaterialCombination
Method AddMaterialPlot() (p. 583) Creates a new MaterialPlot
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 583)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 584)
Method RefreshMaterials() (p. 584) 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.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 581
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 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.

Declaration Syntax
public virtual Figure AddFigure()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
582 of ANSYS, Inc. and its subsidiaries and affiliates.
 Materials

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()
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

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 583
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.)

RefreshMaterials()
Run the RefreshMaterials action.

Declaration Syntax
public virtual void RefreshMaterials()

MemberSizeManufacturingConstraint
Defines a MemberSizeManufacturingConstraint.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
584 of ANSYS, Inc. and its subsidiaries and affiliates.
 MemberSizeManufacturingConstraint

Declaration Syntax
public class MemberSizeManufacturingConstraint : ManufacturingConstraint

Table 202: Members

Property Children (p. 556) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 556).)
Property DataModelObjectCategory (p. 585)Gets the current DataModelObject's
category.
Property GapSize (p. 585) Gets or sets the GapSize.
Property GapSizeControlledType (p. 586) Gets or sets the GapSizeControlledType.
Property InternalObject (p. 586) Gets the internal object. For advanced usage
only.
Property Location (p. 586) Gets or sets the Location.
Property Maximum (p. 586) Gets or sets the Maximum.
Property MaxSize (p. 586) Gets or sets the MaxSize.
Property Minimum (p. 586) Gets or sets the Minimum.
Property MinSize (p. 587) Gets or sets the MinSize.
Property ScopingMethod (p. 587) Gets or sets the ScopingMethod.
Property Selection (p. 557) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 585
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
586 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshConnection

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.

Declaration Syntax
public class MeshConnection : MeshConnectionBase

Table 203: Members

Property Children (p. 591) Gets the list of children.

(Inherited from
MeshConnectionBase (p. 590).)
Property Comments (p. 591) Gets the list of associated comments.

(Inherited from
MeshConnectionBase (p. 590).)
Property ContactRegion (p. 589) Gets or sets the ContactRegion.
Property DataModelObjectCategory (p. 589)Gets the current DataModelObject's
category.
Property Figures (p. 592) Gets the list of associated figures.

(Inherited from
MeshConnectionBase (p. 590).)
Property Images (p. 592) Gets the list of associated images.

(Inherited from
MeshConnectionBase (p. 590).)
Property InternalObject (p. 589) Gets the internal object. For advanced usage
only.
Property MasterBodies (p. 592) Gets the MasterBodies.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 587
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from
MeshConnectionBase (p. 590).)
Property MasterElementSizeFactor (p. 589) Gets or sets the MasterElementSizeFactor.
Property MasterLocation (p. 592) Gets or sets the MasterLocation.

(Inherited from
MeshConnectionBase (p. 590).)
Property ScopeMode (p. 592) Gets the ScopeMode.

(Inherited from
MeshConnectionBase (p. 590).)
Property ScopingMethod (p. 593) No details are provided for this entry.

(Inherited from
MeshConnectionBase (p. 590).)
Property SlaveBodies (p. 593) Gets the SlaveBodies.

(Inherited from
MeshConnectionBase (p. 590).)
Property SlaveLocation (p. 593) Gets or sets the SlaveLocation.

(Inherited from
MeshConnectionBase (p. 590).)
Property SnapToBoundary (p. 593) Gets or sets the SnapToBoundary.

(Inherited from
MeshConnectionBase (p. 590).)
Property SnapTolerance (p. 593) Gets or sets the SnapTolerance.

(Inherited from
MeshConnectionBase (p. 590).)
Property SnapType (p. 593) Gets or sets the SnapType.

(Inherited from
MeshConnectionBase (p. 590).)
Property Suppressed (p. 594) Gets or sets the Suppressed.

(Inherited from
MeshConnectionBase (p. 590).)
Property ThicknessScaleFactor (p. 589) Gets or sets the ThicknessScaleFactor.
Property ToleranceSlider (p. 594) Gets or sets the ToleranceSlider.

(Inherited from
MeshConnectionBase (p. 590).)
Property ToleranceType (p. 594) Gets or sets the ToleranceType.

(Inherited from
MeshConnectionBase (p. 590).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
588 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshConnection

Property ToleranceValue (p. 589) Gets or sets the ToleranceValue.

Method CreateNamedSelection() (p. 590) No details are provided for this entry.
Method FlipMasterSlave() (p. 590) 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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 589
Ansys.ACT.Automation.Mechanical Namespace

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()

MeshConnectionBase
Defines a MeshConnectionBase.

Defines a MeshConnectionBase.

Declaration Syntax
public class MeshConnectionBase : DataModelObject, IFolderDataModelObject

Table 204: Members

Property Children (p. 591) Gets the list of children.

Property Comments (p. 591) Gets the list of associated comments.
Property DataModelObjectCategory (p. 591) 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 MasterBodies (p. 592) Gets the MasterBodies.
Property MasterLocation (p. 592) Gets or sets the MasterLocation.
Property ScopeMode (p. 592) Gets the ScopeMode.
Property ScopingMethod (p. 593) No details are provided for this entry.
Property SlaveBodies (p. 593) Gets the SlaveBodies.
Property SlaveLocation (p. 593) Gets or sets the SlaveLocation.
Property SnapToBoundary (p. 593) Gets or sets the SnapToBoundary.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
590 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshConnectionBase

Property SnapTolerance (p. 593) Gets or sets the SnapTolerance.

Property SnapType (p. 593) Gets or sets the SnapType.
Property Suppressed (p. 594) Gets or sets the Suppressed.
Property ToleranceSlider (p. 594) Gets or sets the ToleranceSlider.
Property ToleranceType (p. 594) Gets or sets the ToleranceType.
Method AddComment() (p. 594) Creates a new child Comment.
Method AddFigure() (p. 594) 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. 595) Run the Delete action.
Method Generate() (p. 595) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 595)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 595)
Method RenameBasedOnDefinition() (p. 596) Run the RenameBasedOnDefinition 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 591
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 IDSMeshConnectionAuto InternalObject { get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
592 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshConnectionBase

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 593
Ansys.ACT.Automation.Mechanical Namespace

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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
594 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshConnectionBase

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 595
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.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

MeshConnectionGroup
Defines a MeshConnectionGroup.

Declaration Syntax
public class MeshConnectionGroup : ConnectionGroup

Table 205: Members

Property ActiveConnections (p. 3141) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 3140).)

Property AutomaticFixedJoints (p. 3142) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 3140).)

Property Children (p. 3142) Gets the list of children.

(Inherited from ConnectionGroup (p. 3140).)

Property Comments (p. 3142) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 3140).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
596 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshConnectionGroup

Property Connections (p. 3142) Gets the Connections.

(Inherited from ConnectionGroup (p. 3140).)

Property ConnectionType (p. 3142) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 3140).)

Property CylindricalFaces (p. 3142) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 3140).)

Property DataModelObjectCategory (p. 598) Gets the current DataModelObject's category.
Property EdgeEdge (p. 3143) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 3140).)

Property EdgeOverlapTolerance (p. 3143) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceAngleTolerance (p. 3143) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceEdge (p. 3143) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceFace (p. 3143) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceFaceDetectionAngleTolerence (p. 3144) Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceOverlapTolerance (p. 3144) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property Figures (p. 3144) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 3140).)

Property GroupBy (p. 3144) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 3140).)

Property Images (p. 3144) Gets the list of associated images.

(Inherited from ConnectionGroup (p. 3140).)

Property InternalObject (p. 598) Gets the internal object. For advanced usage
only.
Property Location (p. 3145) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 3140).)

Property MinimumDistancePercentage (p. 3145) Gets or sets the MinimumDistancePercentage.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 597
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 3140).)

Property MinimumDistanceValue (p. 3145) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 3140).)

Property Priority (p. 3145) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 3140).)

Property RevoluteJoints (p. 3145) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 3140).)

Property SearchAcross (p. 3145) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 3140).)

Property Suppressed (p. 3146) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 3140).)

Property ThicknessScaleFactor (p. 3146) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceSlider (p. 3146) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceType (p. 3146) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceValue (p. 3146) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 3140).)

Property UseRange (p. 3146) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 3140).)

Method AddManualMeshConnection() (p. 599) Creates a new MeshConnection
Method DetectConnections() (p. 599) Detect mesh connections.
Method Generate() (p. 599) Generate mesh connections.
Method SearchConnectionsForDuplicatePairs() (p. 599) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
598 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshControlWorksheet

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()

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 206: Members

Property RowCount (p. 600) Gets the number of entries

Method AddRow() (p. 600) Add a row to the MeshControlWorksheet

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 599
Ansys.ACT.Automation.Mechanical Namespace

Method ClearGenerateMesh() (p. 600) Clear Mesh

Method DeleteAllRows() (p. 600) Delete All Rows
Method DeleteRow(int) (p. 601) Delete a row from the
MeshControlWorksheet
Method GenerateAtRow(int) (p. 601) Generate Mesh At Row
Method GenerateMesh() (p. 601) Geneate Mesh
Method GetActiveState(int) (p. 601) Gets the Active State property at row index
Method GetNamedSelection(int) (p. 602) Gets the NamedSelection at row index
Method GetNamedSelectionId(int) (p. 602) Gets the ID of the NamedSelection at row
index
Method SetActiveState(int, bool) (p. 602) Sets the Active State property at row index
Method SetNamedSelection(int, Sets the NamedSelection at row index
NamedSelection) (p. 603)
Method SetNamedSelectionId(int, uint) (p. 603) 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()

DeleteAllRows()
Delete All Rows

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
600 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshControlWorksheet

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

Declaration Syntax
public virtual bool GetActiveState(int index)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 601
Ansys.ACT.Automation.Mechanical Namespace

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
602 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshEdit

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)

Parameters
index(int)

No details are provided for this entry.

value(uint)

No details are provided for this entry.

MeshEdit
Defines a MeshEdit.

Release 2022 R2 - © 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 class MeshEdit : DataModelObject, IFolderDataModelObject

Table 207: Members

Property AssociateToPullGeometry (p. 605) To Migrate Boundary Conditions from

profile to resulting Pull bodies.
Property Children (p. 605) Gets the list of children.
Property Comments (p. 605) Gets the list of associated comments.
Property DataModelObjectCategory (p. 605) Gets the current DataModelObject's
category.
Property Figures (p. 605) Gets the list of associated figures.
Property GenerateAutomaticMeshConnectionsOnRefresh (p. 606) Gets or sets the
GenerateAutomaticMeshConnectionsOnRefresh.
Property Images (p. 606) Gets the list of associated images.
Property InternalObject (p. 606) Gets the internal object. For advanced
usage only.
Property TransparencyEnabled (p. 606) Gets or sets the TransparencyEnabled.
Method AddComment() (p. 606) Creates a new child Comment.
Method AddContactMatchGroup() (p. 606) Creates a new ContactMatchGroup
Method AddDirectMorph() (p. 607) Creates a new DirectMorph
Method AddFigure() (p. 607) Creates a new child Figure.
Method AddImage(string) (p. 607) 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. 607) Add a new ManualMeshConnection
Method AddMeshConnectionGroup() (p. 607) Creates a new MeshConnectionGroup
Method AddNodeMerge() (p. 608) Add a new NodeMerge.
Method AddNodeMergeGroup() (p. 608) Creates a new NodeMergeGroup
Method AddNodeMove() (p. 608) Creates a new NodeMove
Method AddPullExtrude() (p. 608) Creates a new MeshExtrude
Method AddPullRevolve() (p. 608) Creates a new MeshExtrude
Method AddPullSurfaceCoating() (p. 608) Creates a new MeshExtrude
Method ClearGeneratedData() (p. 609) Clear the generated data.
Method CreateNamedSelectionForSharedNodes() (p. 609) Run the
CreateNamedSelectionForSharedNodes
action.
Method Generate() (p. 609) Generate all mesh edits.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 609)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
604 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshEdit

Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.

IList<IDataModelObject>) (p. 609)
Method RenameBasedOnDefinition() (p. 610) Run the RenameBasedOnDefinition action.
Method SearchConnectionsForDuplicatePairs() (p. 610) 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.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 605
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual Comment AddComment()

AddContactMatchGroup()
Creates a new ContactMatchGroup

Declaration Syntax
public virtual ContactMatchGroup AddContactMatchGroup()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
606 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshEdit

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

Declaration Syntax
public virtual void AddManualMeshConnection()

AddMeshConnectionGroup()
Creates a new MeshConnectionGroup

Declaration Syntax
public virtual MeshConnectionGroup AddMeshConnectionGroup()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 607
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual MeshExtrude AddPullRevolve()

AddPullSurfaceCoating()
Creates a new MeshExtrude

Declaration Syntax
public virtual MeshExtrude AddPullSurfaceCoating()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
608 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshEdit

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)

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 2022 R2 - © 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 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()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
610 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshExtrude

Declaration Syntax
public class MeshExtrude : DataModelObject, IFolderDataModelObject

Table 208: Members

Property AxisOfRevolution (p. 612) 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. 612) Gets the list of children.
Property Comments (p. 613) Gets the list of associated comments.
Property CoordinateSystem (p. 613) To generate elements in the specified coordinate
system. The Coordinate System allows to select the
Global Coordinate System by default.
Property DataModelObjectCategory (p. 613) Gets the current DataModelObject's category.
Property ExtrudeBy (p. 613) To specify the method of Extrude. The available
options are Use Coordinate System and Face
Normal.
Property FeatureAngle (p. 613) To specify feature angle for splitting side faces.
Property Figures (p. 613) Gets the list of associated figures.
Property Height (p. 614) To specify the height for the volume of solid
elements in the method of Extrude.
Property Images (p. 614) Gets the list of associated images.
Property InternalObject (p. 614) Gets the internal object. For advanced usage only.
Property Location (p. 614) 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. 614) To select the material of your choice. You can also
select a different material from the parent body
material.
Property MergeProfileNodes (p. 615) To merge nodes on the profile body and pull
generated body.
Property Method (p. 615) To select the method of Pull. There are three
methods. They are Extrude, Revolve and Surface
Coating.
Property NumberOfLayers (p. 615) To specify the number of layers to be used for
Extrude and Revolve.
Property RevolutionAngle (p. 615) To specify angle of revolution for the solid elements
in the method of Revolve.
Property ScopingMethod (p. 615) Defines what type of selection this object is scoped
to.
Property StiffnessOption (p. 615) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 611
Ansys.ACT.Automation.Mechanical Namespace

Property Suppressed (p. 616) 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 Thickness (p. 616) 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. 616) 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. 616) The target can be faces from solids or sheet bodies
and multiple faces with sharing topoedge in
Extrude UpTo.
Property UseCoordinateSystem (p. 616) The Use Coordinate System allows to select any of
the XYZ coordinate axis in the method of Extrude.
Property UseFeatureAngle (p. 616) To split side faces by speficied feature angle.
Method AddComment() (p. 617) Creates a new child Comment.
Method AddFigure() (p. 617) Creates a new child Figure.
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 ClearGeneratedData() (p. 617) Clear generated data.
Method Delete() (p. 617) Run the Delete action.
Method Generate() (p. 618) Generate selected mesh pull.
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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
612 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshExtrude

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 613
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
614 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshExtrude

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 615
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
616 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshExtrude

Declaration Syntax
public bool UseFeatureAngle { 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()
Clear generated data.

Declaration Syntax
public virtual void ClearGeneratedData()

Delete()
Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 617
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual void Delete()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
618 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshNumbering

children(IList<IDataModelObject>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

MeshNumbering
Defines a MeshNumbering.

Declaration Syntax
public class MeshNumbering : DataModelObject, IFolderDataModelObject

Table 209: Members

Property Children (p. 619) Gets the list of children.

Property Comments (p. 620) Gets the list of associated comments.
Property CompressNodeNumbers (p. 620) Gets or sets the CompressNodeNumbers.
Property DataModelObjectCategory (p. 620) Gets the current DataModelObject's category.
Property ElementOffset (p. 620) Gets or sets the ElementOffset.
Property Figures (p. 620) Gets the list of associated figures.
Property Images (p. 620) Gets the list of associated images.
Property InternalObject (p. 621) Gets the internal object. For advanced usage only.
Property NodeOffset (p. 621) Gets or sets the NodeOffset.
Property Suppressed (p. 621) Gets or sets the Suppressed.
Method AddComment() (p. 621) Creates a new child Comment.
Method AddFigure() (p. 621) Creates a new child Figure.
Method AddImage(string) (p. 621) 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. 622) Creates a new NumberingControl
Method Delete() (p. 622) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 622)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 622)
Method RenumberMesh() (p. 623) Run the RenumberMesh action.

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 619
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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
620 of ANSYS, Inc. and its subsidiaries and affiliates.
 MeshNumbering

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 621
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Image AddImage(string filePath)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
622 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 210: Members

Property AEDTImportManager (p. 629) Get the manager for manipulating

import settings for AEDT files.
Property Ambient (p. 629) Gets or sets the Ambient Lighting
factor.
Property AMProcess (p. 629) Gets the AMProcess.
Property Analyses (p. 630) Gets the Analyses.
Property CellId (p. 630) Gets the CellId.
Property Children (p. 630) Gets the list of children.
Property Color (p. 630) Gets or sets the Lighting Color. Can
also be set using Hex color codes;

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 623
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. 630) Gets the list of associated
comments.
Property CondensedGeometry (p. 630) Gets the CondensedGeometry.
Property Connections (p. 631) Gets the Connections.
Property ConstructionGeometry (p. 631) Gets the ConstructionGeometry.
Property Control (p. 631) Gets the Control.
Property CoordinateSystems (p. 631) Gets the CoordinateSystems.
Property CrossSections (p. 631) Gets the CrossSections.
Property DataModelObjectCategory (p. 631) Gets the current DataModelObject's
category.
Property Diffuse (p. 632) Gets or sets the Diffuse Lighting
factor.
Property Environments ***OBSOLETE*** Use 'Analyses' property Gets the Analyses.
instead. (p. 632)
Property FeatureDetection (p. 632) Gets the FeatureDetection.
Property Figures (p. 632) Gets the list of associated figures.
Property Fracture (p. 632) Gets the Fracture.
Property Geometry (p. 632) Gets the Geometry.
Property GeometryImportGroup (p. 633) Gets the GeometryImportGroup.
Property Images (p. 633) Gets the list of associated images.
Property InternalObject (p. 633) Gets the internal object. For
advanced usage only.
Property Materials (p. 633) Gets the Materials.
Property Mesh (p. 633) Gets the Mesh.
Property MeshEdit (p. 633) Gets the MeshEdit.
Property MeshNumbering (p. 634) Gets the MeshNumbering.
Property NamedSelections (p. 634) Gets the NamedSelections.
Property ParameterVariableGroup (p. 634) Gets the ParameterVariableGroup.
Property PartTransformGroup (p. 634) Gets the PartTransformGroup.
Property RemotePoints (p. 634) Gets the RemotePoints.
Property Specular (p. 634) Gets or sets the Specular Lighting
factor.
Property Symmetry (p. 635) Gets the Symmetry.
Property SystemCaption (p. 635) Gets the SystemCaption.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
624 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

Property VirtualTopology (p. 635) Gets the VirtualTopology.

Method AddAMProcess() (p. 635) Creates a new AMProcess
Method AddChart() (p. 635) Creates a new child Chart.
Method AddComment() (p. 635) Creates a new child Comment.
Method AddCondensedGeometry() (p. 636) Creates a new CondensedGeometry
Method AddConnections() (p. 636) Creates a new Connections
Method AddConstructionGeometry() (p. 636) Creates a new
ConstructionGeometry
Method AddCoSimulationPin() (p. 636) Creates a new CoSimulationPin
Method AddCoupledFieldHarmonic() (p. 636) Run the AddCoupledFieldHarmonic
action.
Method AddCoupledFieldModal() (p. 636) Run the AddCoupledFieldModal
action.
Method AddCoupledFieldStatic() (p. 637) Run the AddCoupledFieldStatic
action.
Method AddCoupledFieldTransient() (p. 637) Run the AddCoupledFieldTransient
action.
Method AddDesignAssessmentAnalysis() (p. 637) Run the
AddDesignAssessmentAnalysis
action.
Method AddDesignLifeAnalysis() (p. 637) Run the AddDesignLifeAnalysis
action.
Method AddEigenvalueBucklingAnalysis() (p. 637) Run the
AddEigenvalueBucklingAnalysis
action.
Method AddElectricAnalysis() (p. 637) Run the AddElectricAnalysis action.
Method AddExplicitDynamicsAnalysis() (p. 638) Run the
AddExplicitDynamicsAnalysis
action.
Method AddFatigueCombination() (p. 638) Creates a new FatigueCombination
Method AddFeatureDetection() (p. 638) Creates a new FeatureDetection
Method AddFigure() (p. 638) Creates a new child Figure.
Method AddForcedResponseAnalysis() (p. 638) Run the
AddForcedResponseAnalysis action.
Method AddFracture() (p. 638) Creates a new Fracture
Method AddGeometryImportGroup() (p. 639) Get the

GeometryImportGroup instance.
Method AddHarmonicAcousticAnalysis() (p. 639) Run the
AddHarmonicAcousticAnalysis
action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 625
Ansys.ACT.Automation.Mechanical Namespace

Method AddHarmonicResponseAnalysis() (p. 639) Run the

AddHarmonicResponseAnalysis
action.
Method AddImage(string) (p. 639) 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. 639) Creates an ImagePlane and adds it
as a child of this object.
Method AddLSDynaAnalysis() (p. 640) Run the AddLSDynaAnalysis action.
Method AddMagnetostaticAnalysis() (p. 640) Run the AddMagnetostaticAnalysis
action.
Method AddMeshEdit() (p. 640) Creates a new MeshEdit
Method AddMeshNumbering() (p. 640) Creates a new MeshNumbering
Method AddModalAcousticAnalysis() (p. 640) Run the AddModalAcousticAnalysis
action.
Method AddModalAnalysis() (p. 640) Run the AddModalAnalysis action.
Method AddMotionAnalysis() (p. 641) Run the AddMotionAnalysis action.
Method AddNamedSelection() (p. 641) Creates a new child
NamedSelection.
Method AddNamedSelectionFromSelectedConnections() (p. 641) Creates a new Named Selections
(Components) for the selected
connections.
Method AddParameterVariableGroup() (p. 641) Get the

ParameterVariableGroup instance.
Method AddPartTransform() (p. 641) Creates a new child PartTransform.
Method AddPythonCodeEventBased() (p. 642) Creates a new
PythonCodeEventBased
Method AddPythonResult() (p. 642) Creates a new PythonResult
Method AddRandomVibrationAnalysis() (p. 642) Run the
AddRandomVibrationAnalysis
action.
Method AddRemotePoint() (p. 642) Creates a new child RemotePoint.
Method AddResponseSpectrumAnalysis() (p. 642) Run the
AddResponseSpectrumAnalysis
action.
Method AddRigidDynamicsAnalysis() (p. 642) Run the AddRigidDynamicsAnalysis
action.
Method AddSolutionCombination() (p. 643) Creates a new SolutionCombination
Method AddStaticAcousticAnalysis() (p. 643) Run the AddStaticAcousticAnalysis
action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
626 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

Method AddStaticStructuralAnalysis() (p. 643) Run the AddStaticStructuralAnalysis

action.
Method AddSteadyStateThermalAnalysis() (p. 643) Run the
AddSteadyStateThermalAnalysis
action.
Method AddSubstructureGenerationAnalysis() (p. 643) Run the
AddSubstructureGenerationAnalysis
action.
Method AddSymmetry() (p. 643) Creates a new Symmetry
Method AddThermalElectricAnalysis() (p. 644) Run the AddThermalElectricAnalysis
action.
Method AddTopologyOptimizationAnalysis() (p. 644) Run the
AddTopologyOptimizationAnalysis
action.
Method AddTransientStructuralAnalysis() (p. 644) Run the
AddTransientStructuralAnalysis
action.
Method AddTransientThermalAnalysis() (p. 644) Run the
AddTransientThermalAnalysis
action.
Method AddTreeGroupingFolder(IDataModelObject) (p. 644) Move the Data Model Object to a
new TreeGroupingFolder.
Method AddTreeGroupingFolder(IEnumerable) (p. 645) Move the Data Model Objects to a
new TreeGroupingFolder.
Method AddVirtualTopology() (p. 645) Creates a new VirtualTopology
Method AutoFilter() (p. 645) Enables interface filtering that only
displays model-level items
applicable to the particular analysis
type environments in which you
are working.
Method ClearGeneratedData() (p. 645) Run the ClearGeneratedData action.
Method CreateCylindricalBolt(object, object, object, Create bolt with a cylinder head
object) (p. 645) 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 CreateCylindricalNut(object, object, object) (p. 646) 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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 627
Ansys.ACT.Automation.Mechanical Namespace

`Quantity` 3) A string
representation of `double` or
`Quantity`, i.e., "1.0" or "1.0 [cm]"
Method CreateHexBolt(object, object, object, object) (p. 646) 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. 647) 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. 647) 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. 648) Deletes the provide parts if they
exist. Otherwise, nothing happens.
An exception will be issued if the
argument is invalid.
Method DisableFilter() (p. 648) Disables interface filtering so that
model-level items are not filtered
out based on the environment
types in your model.
Method EvaluateScriptDefinedResults() (p. 648) No details are provided for this
entry.
Method FreezeMeshOnSelectedParts(object) (p. 648) Run the
FreezeMeshOnSelectedParts action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 649) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 649) type.
Method GetFECommandsRepository(string, string) (p. 650) Gets the commands repository for
a file from external model.
Method GetResults() (p. 650) Gets the Results from the server.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
628 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

Method GetTransformationOnPart(IGeoPart) (p. 650) Get the transformation matrix of

the provided part.
Method LoadResultFile(string) (p. 650) Creates a results-only system and
loads the result file.
Method RefreshMaterials() (p. 651) Run the RefresMaterials action.
Method SetTransformationOnPart(IGeoPart, Transform a part with given
RigidBodyTransformationMatrix) (p. 651) 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. 651) Run the Solve action.
Method Solve(bool, string) (p. 652) Run the Solve action.
Method UnfreezeMeshOnSelectedParts(object) (p. 652) Run the
UnfreezeMeshOnSelectedParts
action.
Method UpdateGeometryFromSource() (p. 652) 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; }

AMProcess
Gets the AMProcess.

Declaration Syntax
public AMProcess AMProcess { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 629
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public IEnumerable<Comment> Comments { get; }

CondensedGeometry
Gets the CondensedGeometry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
630 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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.

Declaration Syntax
public CrossSections CrossSections { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 631
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public Fracture Fracture { get; }

Geometry
Gets the Geometry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
632 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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; }

Mesh
Gets the Mesh.

Declaration Syntax
public Mesh Mesh { get; }

MeshEdit
Gets the MeshEdit.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 633
Ansys.ACT.Automation.Mechanical Namespace

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; }

ParameterVariableGroup
Gets the ParameterVariableGroup.

Declaration Syntax
public ParameterVariableGroup ParameterVariableGroup { get; }

PartTransformGroup
Gets the PartTransformGroup.

Declaration Syntax
public PartTransformGroup PartTransformGroup { get; }

RemotePoints
Gets the RemotePoints.

Declaration Syntax
public RemotePoints RemotePoints { get; }

Specular
Gets or sets the Specular Lighting factor.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
634 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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; }

VirtualTopology
Gets the VirtualTopology.

Declaration Syntax
public VirtualTopology VirtualTopology { get; }

AddAMProcess()
Creates a new AMProcess

Declaration Syntax
public virtual AMProcess AddAMProcess()

AddChart()
Creates a new child Chart.

Declaration Syntax
public virtual Chart AddChart()

AddComment()
Creates a new child Comment.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 635
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual Comment AddComment()

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

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
636 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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()

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.

Release 2022 R2 - © 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 virtual Analysis AddElectricAnalysis()

AddExplicitDynamicsAnalysis()
Run the AddExplicitDynamicsAnalysis action.

Declaration Syntax
public virtual Analysis AddExplicitDynamicsAnalysis()

AddFatigueCombination()
Creates a new FatigueCombination

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
638 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

Declaration Syntax
public virtual Fracture AddFracture()

AddGeometryImportGroup()
Get the

GeometryImportGroup instance.

Declaration Syntax
public virtual GeometryImportGroup AddGeometryImportGroup()

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.

Release 2022 R2 - © 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 virtual ImagePlane AddImagePlane()

AddLSDynaAnalysis()
Run the AddLSDynaAnalysis action.

Declaration Syntax
public virtual Analysis AddLSDynaAnalysis()

AddMagnetostaticAnalysis()
Run the AddMagnetostaticAnalysis action.

Declaration Syntax
public virtual Analysis AddMagnetostaticAnalysis()

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()

AddModalAnalysis()
Run the AddModalAnalysis action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
640 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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()

AddParameterVariableGroup()
Get the

ParameterVariableGroup instance.

Declaration Syntax
public virtual ParameterVariableGroup AddParameterVariableGroup()

AddPartTransform()
Creates a new child PartTransform.

Declaration Syntax
public virtual PartTransform AddPartTransform()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 641
Ansys.ACT.Automation.Mechanical Namespace

AddPythonCodeEventBased()
Creates a new PythonCodeEventBased

Declaration Syntax
public virtual PythonCodeEventBased AddPythonCodeEventBased()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
642 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

AddSolutionCombination()
Creates a new SolutionCombination

Declaration Syntax
public virtual SolutionCombination AddSolutionCombination()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 643
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual TreeGroupingFolder AddTreeGroupingFolder(IDataModelObject dataModelObject)

Parameters
dataModelObject(IDataModelObject)

Object to group

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
644 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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()

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 645
Ansys.ACT.Automation.Mechanical Namespace

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
646 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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)

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)

Release 2022 R2 - © 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
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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
648 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 649
Ansys.ACT.Automation.Mechanical Namespace

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
650 of ANSYS, Inc. and its subsidiaries and affiliates.
 Model

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 651
Ansys.ACT.Automation.Mechanical Namespace

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)

Parameters
parts(object)

No details are provided for this entry.

UpdateGeometryFromSource()
Run the UpdateGeometryFromSource action.

Declaration Syntax
public virtual void UpdateGeometryFromSource()

MomentOfInertiaConstraint
Defines a MomentOfInertiaConstraint.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
652 of ANSYS, Inc. and its subsidiaries and affiliates.
 MomentOfInertiaConstraint

Declaration Syntax
public class MomentOfInertiaConstraint : ResponseConstraint

Table 211: Members

Property Axis (p. 653) Gets or sets the Axis.

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property CoordinateSystem (p. 653) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 654) Gets the current DataModelObject's category.
Property DefineBy (p. 654) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 654)
Property Location (p. 654)
Property MaximumValue (p. 654)
Property MinimumValue (p. 654)
Property PercentageToRetain (p. 655)
Property PercentageToRetainMax (p. 655)
Property PercentageToRetainMin (p. 655)
Property ScopingMethod (p. 655)
Property Selection (p. 655)
Property Suppressed (p. 810)
Gets the internal object. For advanced usage only.
Gets or sets the Location.
Gets or sets the MaximumValue.
Gets or sets the MinimumValue.
Gets or sets the PercentageToRetain.
Gets or sets the PercentageToRetainMax.
Gets or sets the PercentageToRetainMin.
Gets or sets the ScopingMethod.
Gets or sets the Selection.
Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 653
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
654 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelection

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; }

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; }

NamedSelection
Defines a NamedSelection.

Release 2022 R2 - © 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 NamedSelection : ImportedDataModelObject, IMechanicalSelectionInfo, ISelectionInfo,
IFolderDataModelObject

Table 212: Members

Property Children (p. 657) Gets the list of children.

Property Comments (p. 657) Gets the list of associated comments.
Property DataModelObjectCategory (p. 657) Gets the current DataModelObject's
category.
Property Figures (p. 657) Gets the list of associated figures.
Property GenerationCriteria (p. 657) Returns the generation criteria that is used
to generate the selection.
Property Images (p. 658) Gets the list of associated images.
Property IncludeProgramControlledInflation (p. 658) Gets or sets the
IncludeProgramControlledInflation.
Property InternalObject (p. 658) Gets the internal object. For advanced
usage only.
Property Location (p. 658) Gets or sets the Location.
Property LSDynaUserId (p. 658) Gets or sets the LSDynaUserId.
Property PreserveDuringSolve (p. 658) Gets or sets the PreserveDuringSolve.
Property RelativeTolerance (p. 659) Gets or sets the RelativeTolerance.
Property ScopingMethod (p. 659) Gets or sets the ScopingMethod.
Property SendAs (p. 659) Gets or sets the SendAs.
Property SendToSolver (p. 659) Gets or sets the SendToSolver.
Property Suppressed (p. 659) Gets the Suppressed.
Property ToleranceType (p. 659) Gets or sets the ToleranceType.
Property TotalSelection (p. 660) Gets the TotalSelection.
Property Type (p. 660) Gets the Type.
Property UsedByMeshWorksheet (p. 660) Gets the UsedByMeshWorksheet.
Property Visible (p. 660) Gets or sets the Visible.
Property ZeroTolerance (p. 660) Gets or sets the ZeroTolerance.
Method AddComment() (p. 660) Creates a new child Comment.
Method AddFigure() (p. 661) Creates a new child Figure.
Method AddImage(string) (p. 661) 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. 661) Creates a new Named Selection object
containing all the nodes from the entities
in the current named selection .
Method Delete() (p. 661) Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
656 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelection

Method ExportNamedSelectionToCDBFile(string) (p. 661) Export Named Selection to CDB file

Method ExportToTextFile(string) (p. 662) Run the ExportToTextFile action.
Method Generate() (p. 662) Generates the selection based on the
generation criteria.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 662)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 663)

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; }

GenerationCriteria
Returns the generation criteria that is used to generate the selection.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 657
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
658 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelection

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.

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.

Release 2022 R2 - © 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 ToleranceType ToleranceType { set;get; }

TotalSelection
Gets the TotalSelection.

Declaration Syntax
public int TotalSelection { get; }

Type
Gets the Type.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
660 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelection

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.

CreateNodalNamedSelection()
Creates a new Named Selection object containing all the nodes from the entities in the current named
selection .

Declaration Syntax
public virtual void CreateNodalNamedSelection()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

ExportNamedSelectionToCDBFile(string)
Export Named Selection to CDB file

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 661
Ansys.ACT.Automation.Mechanical Namespace

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
662 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelectionCriteria

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.)

NamedSelectionCriteria
A collection of named selection criteria.

Declaration Syntax
public class NamedSelectionCriteria : IList<NamedSelectionCriterion>, ICollection<NamedSelectionCri-
terion>, IEnumerable<NamedSelectionCriterion>, IEnumerable

Table 213: Members

Property Count (p. 664) The number of criteria in the collection.

Property Item (p. 664) The criterion at the given index.
Method Add(NamedSelectionCriterion) (p. 664) Adds the given criterion to the collection.
Method Clear() (p. 664) Clears the collection.
Method Contains(NamedSelectionCriterion) (p. 665) Returns whether the collection contains the
given criterion.
Method IndexOf(NamedSelectionCriterion) (p. 665) Returns the index of the given criterion if it
exists in the collection. Returns -1 if it does not

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 663
Ansys.ACT.Automation.Mechanical Namespace

Method Insert(int, Inserts the given criterion into the collection at

NamedSelectionCriterion) (p. 665) the given index.
Method Remove(NamedSelectionCriterion) (p. 665) Removes the given criterion from the collection
if it exists in the collection. Throws an exception
if it does not.
Method RemoveAt(int) (p. 666) 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.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
664 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelectionCriteria

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 665
Ansys.ACT.Automation.Mechanical Namespace

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)

Parameters
index(int)

No details are provided for this entry.

NamedSelectionCriterion
No details are provided for this entry.

Declaration Syntax
public class NamedSelectionCriterion

Table 214: Members

Constructor NamedSelectionCriterion(bool, Creates a new NamedSelectionCriterion

SelectionActionType, SelectionType, instance with the provided properties.
SelectionCriterionType,
SelectionOperatorType, object, Quantity,
Quantity, CoordinateSystem) (p. 667)
Property Action (p. 668) No details are provided for this entry.
Property Active (p. 668) No details are provided for this entry.
Property CoordinateSystem (p. 668) No details are provided for this entry.
Property Criterion (p. 668) No details are provided for this entry.
Property EntityType (p. 668) No details are provided for this entry.
Property LowerBound (p. 668) No details are provided for this entry.
Property Operator (p. 669) No details are provided for this entry.
Property UpperBound (p. 669) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
666 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelectionCriterion

Property Value (p. 669) 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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 667
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
668 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelections

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; }

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 215: Members

Property Children (p. 670) Gets the list of children.

Property Comments (p. 670) Gets the list of associated comments.
Property DataModelObjectCategory (p. 670) Gets the current DataModelObject's
category.
Property Figures (p. 670) Gets the list of associated figures.
Property GenerateOnRefresh (p. 671) Gets or sets the GenerateOnRefresh.
Property GenerateOnRemesh (p. 671) Gets or sets the GenerateOnRemesh.
Property Images (p. 671) Gets the list of associated images.
Property InternalObject (p. 671) Gets the internal object. For advanced
usage only.
Property RandomColors (p. 671) Gets the RandomColors.
Property ShowAnnotations (p. 671) Gets or sets the ShowAnnotations.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 669
Ansys.ACT.Automation.Mechanical Namespace

Method AddComment() (p. 672) Creates a new child Comment.

Method AddFigure() (p. 672) Creates a new child Figure.
Method AddImage(string) (p. 672) 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. 672) Creates a new NamedSelection
Method Delete() (p. 672) Run the Delete action.
Method ExportNamedSelectionToCDBFile(string) (p. 673) Export Named Selections to CDB file
Method GenerateAllNamedSelections() (p. 673) Generate all named selections
specified with the Worksheet
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 673) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 673) type.
Method GoToNamedSelectionsCommonToSelection() (p. 674) No details are provided for this entry.
Method GoToNamedSelectionsContainingSelection() (p. 674) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
670 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelections

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

GenerateOnRefresh
Gets or sets the GenerateOnRefresh.

Declaration Syntax
public bool GenerateOnRefresh { set;get; }

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.

Release 2022 R2 - © 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 bool ShowAnnotations { 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()

Delete()
Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
672 of ANSYS, Inc. and its subsidiaries and affiliates.
 NamedSelections

Declaration Syntax
public virtual void Delete()

ExportNamedSelectionToCDBFile(string)
Export Named Selections to CDB file

Declaration Syntax
public virtual void ExportNamedSelectionToCDBFile(string filepath)

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.

Release 2022 R2 - © 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 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.)

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 216: Members

Constructor NastranExportOptions(string, string, int, int, double, No details are provided for this
double, string, int, double, bool) (p. 675) entry.
Property AnalysisType (p. 676) Analysis type.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
674 of ANSYS, Inc. and its subsidiaries and affiliates.
 NastranExportOptions

Property GridCS (p. 676) Grid coordinate system

number.
Property GroundCheck (p. 676) Ground check.
Property JointStiffness (p. 676) Joint stiffness.
Property Modes (p. 677) Modes.
Property NastranFilename (p. 677) Full path of Nastran export file.
Property Offset (p. 677) Offset.
Property PyramidElements (p. 677) Pyramid elements.
Property Time (p. 677) Time.
Property WTMass (p. 677) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 675
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
676 of ANSYS, Inc. and its subsidiaries and affiliates.
 NastranExportOptions

Modes
Modes.

Declaration Syntax
public int Modes { set;get; }

NastranFilename
Full path of Nastran export file.

Declaration Syntax
public string NastranFilename { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 677
Ansys.ACT.Automation.Mechanical Namespace

NaturalFrequencyConstraint
Defines a NaturalFrequencyConstraint.

Declaration Syntax
public class NaturalFrequencyConstraint : ResponseConstraint

Table 217: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 678)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 678)
Property MaximumFrequency (p. 678)
Property MinimumFrequency (p. 679)
Property ModeNumber (p. 679)
Property Suppressed (p. 810)
Gets the internal object. For advanced usage only.
Gets or sets the MaximumFrequency.
Gets or sets the MinimumFrequency.
Gets or sets the ModeNumber.
Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
678 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMerge

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 uint ModeNumber { set;get; }

NodeMerge
Defines a NodeMerge.

Defines a NodeMerge.

Declaration Syntax
public class NodeMerge : DataModelObject, IFolderDataModelObject

Table 218: Members

Property Children (p. 680) Gets the list of children.

Property Comments (p. 680) Gets the list of associated comments.
Property DataModelObjectCategory (p. 680) Gets the current DataModelObject's category.
Property Figures (p. 680) Gets the list of associated figures.
Property Images (p. 681) Gets the list of associated images.
Property InternalObject (p. 681) Gets the internal object. For advanced usage only.
Property MasterBodies (p. 681) Gets the MasterBodies.
Property MasterLocation (p. 681) Gets or sets the MasterLocation.
Property ScopingMethod (p. 681) No details are provided for this entry.
Property SlaveBodies (p. 681) Gets the SlaveBodies.
Property SlaveLocation (p. 682) Gets or sets the SlaveLocation.
Property Suppressed (p. 682) Gets or sets the Suppressed.
Property ToleranceType (p. 682) Gets or sets the ToleranceType.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 679
Ansys.ACT.Automation.Mechanical Namespace

Property ToleranceValue (p. 682) Gets/ Sets the ToleranceValue.

Method AddComment() (p. 682) Creates a new child Comment.
Method AddFigure() (p. 682) Creates a new child Figure.
Method AddImage(string) (p. 683) 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. 683) Run the Delete action.
Method Generate() (p. 683) Run the Generate action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 683)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 684)
Method RenameBasedOnDefinition() (p. 684) Run the RenameBasedOnDefinition 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
680 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMerge

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 681
Ansys.ACT.Automation.Mechanical Namespace

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; }

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
682 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMerge

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 683
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.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

NodeMergeGroup
Defines a NodeMergeGroup.

Declaration Syntax
public class NodeMergeGroup : ConnectionGroup

Table 219: Members

Property ActiveConnections (p. 3141) Gets the ActiveConnections.

(Inherited from ConnectionGroup (p. 3140).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
684 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMergeGroup

Property AutomaticFixedJoints (p. 3142) Gets or sets the AutomaticFixedJoints.

(Inherited from ConnectionGroup (p. 3140).)

Property Children (p. 3142) Gets the list of children.

(Inherited from ConnectionGroup (p. 3140).)

Property Comments (p. 3142) Gets the list of associated comments.

(Inherited from ConnectionGroup (p. 3140).)

Property Connections (p. 3142) Gets the Connections.

(Inherited from ConnectionGroup (p. 3140).)

Property ConnectionType (p. 3142) Gets or sets the ConnectionType.

(Inherited from ConnectionGroup (p. 3140).)

Property CylindricalFaces (p. 3142) Gets or sets the CylindricalFaces.

(Inherited from ConnectionGroup (p. 3140).)

Property DataModelObjectCategory (p. 686) Gets the current DataModelObject's category.
Property EdgeEdge (p. 3143) Gets or sets the EdgeEdge.

(Inherited from ConnectionGroup (p. 3140).)

Property EdgeOverlapTolerance (p. 3143) Gets or sets the EdgeOverlapTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceAngleTolerance (p. 3143) Gets or sets the FaceAngleTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceEdge (p. 3143) Gets or sets the FaceEdge.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceFace (p. 3143) Gets or sets the FaceFace.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceFaceDetectionAngleTolerence (p. 3144)Gets or sets the
FaceFaceDetectionAngleTolerence.

(Inherited from ConnectionGroup (p. 3140).)

Property FaceOverlapTolerance (p. 3144) Gets or sets the FaceOverlapTolerance.

(Inherited from ConnectionGroup (p. 3140).)

Property Figures (p. 3144) Gets the list of associated figures.

(Inherited from ConnectionGroup (p. 3140).)

Property GroupBy (p. 3144) Gets or sets the GroupBy.

(Inherited from ConnectionGroup (p. 3140).)

Property Images (p. 3144) Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 685
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ConnectionGroup (p. 3140).)

Property InternalObject (p. 687) Gets the internal object. For advanced usage
only.
Property Location (p. 3145) Gets or sets the Location.

(Inherited from ConnectionGroup (p. 3140).)

Property MinimumDistancePercentage (p. 3145) Gets or sets the MinimumDistancePercentage.

(Inherited from ConnectionGroup (p. 3140).)

Property MinimumDistanceValue (p. 3145) Gets the MinimumDistanceValue.

(Inherited from ConnectionGroup (p. 3140).)

Property Priority (p. 3145) Gets or sets the Priority.

(Inherited from ConnectionGroup (p. 3140).)

Property RevoluteJoints (p. 3145) Gets or sets the RevoluteJoints.

(Inherited from ConnectionGroup (p. 3140).)

Property SearchAcross (p. 3145) Gets or sets the SearchAcross.

(Inherited from ConnectionGroup (p. 3140).)

Property Suppressed (p. 3146) Gets or sets the Suppressed.

(Inherited from ConnectionGroup (p. 3140).)

Property ThicknessScaleFactor (p. 3146) Gets or sets the ThicknessScaleFactor.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceSlider (p. 3146) Gets or sets the ToleranceSlider.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceType (p. 3146) Gets or sets the ToleranceType.

(Inherited from ConnectionGroup (p. 3140).)

Property ToleranceValue (p. 3146) Gets or sets the ToleranceValue.

(Inherited from ConnectionGroup (p. 3140).)

Property UseRange (p. 3146) Gets or sets the UseRange.

(Inherited from ConnectionGroup (p. 3140).)

Method AddNodeMerge() (p. 687) Creates a new NodeMerge
Method GenerateNodeMerge() (p. 687) Run the GenerateNodeMerge action.

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
686 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMove

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

Declaration Syntax
public virtual NodeMerge AddNodeMerge()

GenerateNodeMerge()
Run the GenerateNodeMerge action.

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 220: Members

Property Children (p. 688) Gets the list of children.

Property Comments (p. 688) Gets the list of associated comments.
Property DataModelObjectCategory (p. 688) Gets the current DataModelObject's category.
Property Figures (p. 689) Gets the list of associated figures.
Property Images (p. 689) Gets the list of associated images.
Property Information (p. 689) Gets the Information.
Property InternalObject (p. 689) Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 687
Ansys.ACT.Automation.Mechanical Namespace

Property NumberOfMoves (p. 689) Gets the NumberOfMoves.

Property NumberOfNodes (p. 689) Gets the NumberOfNodes.
Method AddComment() (p. 690) Creates a new child Comment.
Method AddFigure() (p. 690) Creates a new child Figure.
Method AddImage(string) (p. 690) 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. 690) 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. 691)
Method MorphNodes() (p. 691) Morph all the nodes.
Method MoveNode(int, Quantity, Quantity, Moves a node to a new specified location.
Quantity) (p. 691)
Method UndoAllNodeMoves() (p. 692) Undos all moves done to a node.
Method UndoLastNodeMove() (p. 692) 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
688 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMove

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 689
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
690 of ANSYS, Inc. and its subsidiaries and affiliates.
 NodeMove

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.)

MorphNodes()
Morph all the nodes.

Declaration Syntax
public virtual void MorphNodes()

MoveNode(int, Quantity, Quantity, Quantity)

Moves a node to a new specified location.

Declaration Syntax
public virtual void MoveNode(int nodeId, Quantity locX, Quantity locY, Quantity locZ)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 691
Ansys.ACT.Automation.Mechanical Namespace

Parameters
nodeId(int)

The id of the node to be moved

locX(Quantity)

New X location

locY(Quantity)

New Y location

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 221: Members

Property BeginElementNumber (p. 693) Gets or sets the BeginElementNumber.

Property BeginNodeNumber (p. 693) Gets or sets the BeginNodeNumber.
Property Children (p. 693) Gets the list of children.
Property Comments (p. 694) Gets the list of associated comments.
Property DataModelObjectCategory (p. 694) Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
692 of ANSYS, Inc. and its subsidiaries and affiliates.
 NumberingControl

Property EndElementNumber (p. 694) Gets or sets the EndElementNumber.

Property EndNodeNumber (p. 694) Gets or sets the EndNodeNumber.
Property Figures (p. 694) Gets the list of associated figures.
Property Images (p. 694) Gets the list of associated images.
Property InternalObject (p. 695) Gets the internal object. For advanced usage only.
Property Location (p. 695) Gets or sets the Location.
Property NodeNumber (p. 695) Gets or sets the NodeNumber.
Property Suppressed (p. 695) Gets or sets the Suppressed.
Method AddComment() (p. 695) Creates a new child Comment.
Method AddFigure() (p. 695) Creates a new child Figure.
Method AddImage(string) (p. 696) 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. 696) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 696)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 696)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 693
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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
694 of ANSYS, Inc. and its subsidiaries and affiliates.
 NumberingControl

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSMeshRenumberingControlAuto InternalObject { get; }

Location
Gets or sets the Location.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 695
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
696 of ANSYS, Inc. and its subsidiaries and affiliates.
 Objective

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.)

Objective
Defines a Objective.

Declaration Syntax
public class Objective : DataModelObject, IFolderDataModelObject

Table 222: Members

Property Children (p. 698) Gets the list of children.

Property Comments (p. 698) Gets the list of associated comments.
Property DataModelObjectCategory (p. 698) Gets the current DataModelObject's category.
Property Images (p. 698) Gets the list of associated images.
Property InternalObject (p. 698) Gets the internal object. For advanced usage only.
Property NormalizedSum (p. 698) Gets or sets the NormalizedSum.
Property Suppressed (p. 699) Gets or sets the Suppressed.
Property Worksheet (p. 699) Get the ObjectiveWorksheet action.
Method AddComment() (p. 699) Creates a new child Comment.
Method AddImage(string) (p. 699) 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. 699) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 700)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 697
Ansys.ACT.Automation.Mechanical Namespace

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.

bool, IList<IDataModelObject>) (p. 700)

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 IDSTopoObjectiveAuto InternalObject { get; }

NormalizedSum
Gets or sets the NormalizedSum.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
698 of ANSYS, Inc. and its subsidiaries and affiliates.
 Objective

Declaration Syntax
public bool NormalizedSum { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 699
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
700 of ANSYS, Inc. and its subsidiaries and affiliates.
 ObjectiveWorksheet

ObjectiveWorksheet
No details are provided for this entry.

Declaration Syntax
public class ObjectiveWorksheet : Worksheet

Table 223: Members

Property RowCount (p. 702) Deletes a row from the worksheet at index.
Method AddRow() (p. 702) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 702) Deletes a row from the worksheet at index.
Method GetEnabled(int) (p. 702) Gets the worksheet Enabled property at row
index
Method GetEndMode(int) (p. 703) Gets the worksheet End Mode property at index.
Method GetEndStep(int) (p. 703) Gets the worksheet End Step property at index.
Method GetEnvironment(int) (p. 703) Gets the worksheet Environment property at
index.
Method GetFormulation(int) (p. 703) Gets the worksheet Formulation property at
index.
Method GetMode(int) (p. 704) Gets the worksheet Mode property at index.
Method GetMultipleSets(int) (p. 704) Gets the worksheet Multiple Sets property at row
index
Method GetObjectiveType(int) (p. 704) Gets the Objective Type property at index.
Method GetStartMode(int) (p. 705) Gets the worksheet Start Mode property at index.
Method GetStartStep(int) (p. 705) Gets the worksheet Start Step property at index.
Method GetStep(int) (p. 705) Gets the worksheet Step property at index.
Method GetWeight(int) (p. 705) Gets the worksheet Weight property at index.
Method SetEnabled(int, bool) (p. 706) Sets the worksheet Enabled property at row
index.
Method SetEndMode(int, int) (p. 706) Sets the worksheet End Mode property at index.
Method SetEndStep(int, int) (p. 706) Sets the worksheet End Step property at index.
Method SetEnvironment(int, Analysis) (p. 707) Sets the worksheet Environment property at
index.
Method SetFormulation(int, Sets the worksheet Formulation property at
TopoObjectiveFormulation) (p. 707) index.
Method SetMode(int, int) (p. 707) Sets the worksheet Mode property at index.
Method SetMultipleSets(int, bool) (p. 708) Sets the worksheet Multiple Sets property at row
index.
Method SetObjectiveType(int, Sets the ObjectiveType property at index.
ObjectiveType) (p. 708)
Method SetStartMode(int, int) (p. 709) Sets the worksheet Start Mode property at index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 701
Ansys.ACT.Automation.Mechanical Namespace

Method SetStartStep(int, int) (p. 709) Sets the worksheet Start Step property at index.
Method SetStep(int, int) (p. 709) Sets the worksheet Step property at index.
Method SetWeight(int, double) (p. 710) Sets the worksheet Weight property at index.

RowCount
Deletes a row from the worksheet at index.

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
702 of ANSYS, Inc. and its subsidiaries and affiliates.
 ObjectiveWorksheet

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 703
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
704 of ANSYS, Inc. and its subsidiaries and affiliates.
 ObjectiveWorksheet

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 705
Ansys.ACT.Automation.Mechanical Namespace

Parameters
index(int)

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
706 of ANSYS, Inc. and its subsidiaries and affiliates.
 ObjectiveWorksheet

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 707
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
708 of ANSYS, Inc. and its subsidiaries and affiliates.
 ObjectiveWorksheet

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 709
Ansys.ACT.Automation.Mechanical Namespace

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.

OptimizationRegion
Defines a OptimizationRegion.

Declaration Syntax
public class OptimizationRegion : OptimizationRegionBaseClass, IMechanicalSelectionInfo, ISelectionInfo

Table 224: Members

Property BoundaryCondition (p. 711) Gets or sets the BoundaryCondition.

Property Children (p. 715) Gets the list of children.

(Inherited from
OptimizationRegionBaseClass (p. 715).)
Property DataModelObjectCategory (p. 711) Gets the current DataModelObject's
category.
Property DesignRegionLocation (p. 712) Gets or sets the DesignRegionLocation.
Property ExclusionRegionLocation (p. 715) Gets or sets the ExclusionRegionLocation.

(Inherited from
OptimizationRegionBaseClass (p. 715).)
Property ExclusionScopingMethod (p. 715) Gets or sets the
ExclusionScopingMethod.

(Inherited from
OptimizationRegionBaseClass (p. 715).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
710 of ANSYS, Inc. and its subsidiaries and affiliates.
 OptimizationRegion

Property ExclusionThickness (p. 712) Gets or sets the ExclusionThickness.

Property InitializationHoleSize (p. 712) Gets or sets the InitializationHoleSize.
Property InitializationModifierType (p. 712) Gets or sets the
InitializationModifierType.
Property InternalObject (p. 712) Gets the internal object. For advanced
usage only.
Property LatticeMaxDensity (p. 712) Gets or sets the LatticeMaxDensity.
Property LatticeMinDensity (p. 713) Gets or sets the LatticeMinDensity.
Property LatticeSize (p. 713) Gets or sets the LatticeSize.
Property LatticeType (p. 713) Gets or sets the LatticeType.
Property MaxCumulatedDisplacementControl (p. 713) Gets or sets the
MaxCumulatedDisplacementControl.
Property MeshDeformationToleranceControl (p. 713) Gets or sets the
MeshDeformationToleranceControl.
Property MorphingIterationMoveLimit (p. 713) Gets or sets the
MorphingIterationMoveLimit.
Property MorphingTotalMeshDeformationTolerance (p. 714) Gets or sets the
MorphingTotalMeshDeformationTolerance.
Property MorphingTotalMoveLimit (p. 714) Gets or sets the
MorphingTotalMoveLimit.
Property OptimizationType (p. 714) Gets or sets the OptimizationType.
Property ShapeMoveLimitControl (p. 714) Gets or sets the ShapeMoveLimitControl.
Method AddExclusionRegion() (p. 714) Creates a new ExclusionRegion
Method RenameBasedOnDefinition() (p. 714) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 711
Ansys.ACT.Automation.Mechanical Namespace

DesignRegionLocation
Gets or sets the DesignRegionLocation.

Declaration Syntax
public ISelectionInfo DesignRegionLocation { set;get; }

ExclusionThickness
Gets or sets the ExclusionThickness.

Declaration Syntax
public Quantity ExclusionThickness { 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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
712 of ANSYS, Inc. and its subsidiaries and affiliates.
 OptimizationRegion

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; }

MaxCumulatedDisplacementControl
Gets or sets the MaxCumulatedDisplacementControl.

Declaration Syntax
public TopoPropertyControlType MaxCumulatedDisplacementControl { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 713
Ansys.ACT.Automation.Mechanical Namespace

MorphingTotalMeshDeformationTolerance
Gets or sets the MorphingTotalMeshDeformationTolerance.

Declaration Syntax
public double MorphingTotalMeshDeformationTolerance { set;get; }

MorphingTotalMoveLimit
Gets or sets the MorphingTotalMoveLimit.

Declaration Syntax
public double MorphingTotalMoveLimit { set;get; }

OptimizationType
Gets or sets the OptimizationType.

Declaration Syntax
public OptimizationType OptimizationType { set;get; }

ShapeMoveLimitControl
Gets or sets the ShapeMoveLimitControl.

Declaration Syntax
public TopoPropertyControlType ShapeMoveLimitControl { set;get; }

AddExclusionRegion()
Creates a new ExclusionRegion

Declaration Syntax
public virtual ExclusionRegion AddExclusionRegion()

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
714 of ANSYS, Inc. and its subsidiaries and affiliates.
 OptimizationRegionBaseClass

OptimizationRegionBaseClass
Defines a OptimizationRegionBaseClass.

Declaration Syntax
public abstract class OptimizationRegionBaseClass : DataModelObject

Table 225: Members

Property Children (p. 715) Gets the list of children.

Property ExclusionRegionLocation (p. 715) Gets or sets the ExclusionRegionLocation.
Property ExclusionScopingMethod (p. 715) Gets or sets the ExclusionScopingMethod.
Property InternalObject (p. 716) Gets the internal object. For advanced
usage only.
Method Delete() (p. 716) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 716)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 716)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 715
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSOptimizationRegionAuto InternalObject { 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
716 of ANSYS, Inc. and its subsidiaries and affiliates.
 ParameterVariable

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.)

ParameterVariable
Defines a ParameterVariable.

Declaration Syntax
public class ParameterVariable : DataModelObject, IFolderDataModelObject

Table 226: Members

Property Children (p. 717) Gets the list of children.

Property Comments (p. 718) Gets the list of associated comments.
Property DataModelObjectCategory (p. 718) Gets the current DataModelObject's category.
Property Figures (p. 718) Gets the list of associated figures.
Property Images (p. 718) Gets the list of associated images.
Property InternalObject (p. 718) Gets the internal object. For advanced usage only.
Method AddComment() (p. 718) Creates a new child Comment.
Method AddFigure() (p. 719) Creates a new child Figure.
Method AddImage(string) (p. 719) 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. 719)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 720)

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 717
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 IDSParameterVariableAuto InternalObject { get; }

AddComment()
Creates a new child Comment.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
718 of ANSYS, Inc. and its subsidiaries and affiliates.
 ParameterVariable

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.

children(IList<ChildrenType>)

Input list that will be populated through the whole process. (If not specified a new list will be
created.)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 719
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.)

ParameterVariableGroup
Defines a ParameterVariableGroup.

Declaration Syntax
public class ParameterVariableGroup : DataModelObject, IFolderDataModelObject

Table 227: Members

Property Children (p. 721) Gets the list of children.

Property Comments (p. 721) Gets the list of associated comments.
Property DataModelObjectCategory (p. 721) Gets the current DataModelObject's category.
Property Figures (p. 721) Gets the list of associated figures.
Property Images (p. 721) Gets the list of associated images.
Property InternalObject (p. 722) Gets the internal object. For advanced usage only.
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 AddParameterVariable() (p. 722) Create the object for working with an imported
part.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
720 of ANSYS, Inc. and its subsidiaries and affiliates.
 ParameterVariableGroup

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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 721
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSParameterVariableGroupAuto 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.

AddParameterVariable()
Create the object for working with an imported part.

Declaration Syntax
public virtual ParameterVariable AddParameterVariable()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
722 of ANSYS, Inc. and its subsidiaries and affiliates.
 Part

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.)

Part
Defines a Part.

Release 2022 R2 - © 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 class Part : ImportedDataModelObject, IFolderDataModelObject
Table 228: Members
Property ApproximateSurfaceArea (p. 725)
Property Assignment ***OBSOLETE*** Use
'Material' property instead. (p. 725)
Property Average (p. 725)
Property CentroidX (p. 725)
Property CentroidY (p. 726)
Property CentroidZ (p. 726)
Property Children (p. 726)
Property Comments (p. 726)
Property ConfigurationId (p. 726)
Property CoordinateSystem (p. 726)
Property DataModelObjectCategory (p. 727)
Property Elements (p. 727)
Property Figures (p. 727)
Property Hidden (p. 727)
Property Images (p. 727)
Property InternalObject (p. 727)
Property LengthX (p. 728)
Property LengthY (p. 728)
Property LengthZ (p. 728)
Property Mass (p. 728)
Property Material (p. 728)
Property MaterialName ***OBSOLETE*** Use
'Assignment' property instead. (p. 728)
Property Maximum (p. 729)
Property MeshMetric (p. 729)
Property Minimum (p. 729)
Property MomentOfInertiaIp1 (p. 729)
Property MomentOfInertiaIp2 (p. 729)
Property MomentOfInertiaIp3 (p. 729)
Property Nodes (p. 730)
Property ResultMeshId (p. 730)
Property StandardDeviation (p. 730)
Property Suppressed (p. 730)
Property Visible (p. 730)
Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
724
Gets the ApproximateSurfaceArea.
Gets or sets the Assignment.
Gets the Average.
Gets the CentroidX.
Gets the CentroidY.
Gets the CentroidZ.
Gets the list of children.
Gets the list of associated comments.
Gets the related Result Mesh's ConfigurationId.
Gets or sets the CoordinateSystem.
Gets the current DataModelObject's category.
Gets the Elements.
Gets the list of associated figures.
Hide or show the body.
Gets the list of associated images.
Gets the internal object. For advanced usage only.
Gets the LengthX.
Gets the LengthY.
Gets the LengthZ.
Gets the Mass.
Gets or sets the Material.
Gets or sets the MaterialName.
Gets the Maximum.
Gets the MeshMetric.
Gets the Minimum.
Gets the MomentOfInertiaIp1.
Gets the MomentOfInertiaIp2.
Gets the MomentOfInertiaIp3.
Gets the Nodes.
Gets the related Result Mesh's ObjectId.
Gets the StandardDeviation.
Gets or sets the Suppressed.
Gets or sets the Visible.
of ANSYS, Inc. and its subsidiaries and affiliates.
 Part

Property Volume (p. 730) Gets the Volume.

Method AddComment() (p. 731) Creates a new child Comment.
Method AddFigure() (p. 731) Creates a new child Figure.
Method AddImage(string) (p. 731) 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. 731) Run the ClearGeneratedData action.
Method GenerateMesh() (p. 731) Run the GenerateMesh action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 732)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 732)
Method PreviewInflation() (p. 732) Run the PreviewInflation action.
Method PreviewSurfaceMesh() (p. 733) Run the PreviewSurfaceMesh action.
Method Update() (p. 733) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 725
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
726 of ANSYS, Inc. and its subsidiaries and affiliates.
 Part

Declaration Syntax
public CoordinateSystem CoordinateSystem { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Elements
Gets the Elements.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 727
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IDSBodyGroupAuto InternalObject { 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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
728 of ANSYS, Inc. and its subsidiaries and affiliates.
 Part

Declaration Syntax
public string MaterialName { set;get; }

Maximum
Gets the Maximum.

Declaration Syntax
public double Maximum { get; }

MeshMetric
Gets the MeshMetric.

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.

Release 2022 R2 - © 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 Quantity MomentOfInertiaIp3 { get; }

Nodes
Gets the Nodes.

Declaration Syntax
public int Nodes { get; }

ResultMeshId
Gets the related Result Mesh's ObjectId.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
730 of ANSYS, Inc. and its subsidiaries and affiliates.
 Part

Declaration Syntax
public Quantity Volume { 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()

GenerateMesh()
Run the GenerateMesh action.

Release 2022 R2 - © 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 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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
732 of ANSYS, Inc. and its subsidiaries and affiliates.
 PartTransform

Declaration Syntax
public virtual void PreviewInflation()

PreviewSurfaceMesh()
Run the PreviewSurfaceMesh action.

Declaration Syntax
public virtual void PreviewSurfaceMesh()

Update()
Run the Update action.

Declaration Syntax
public virtual void Update()

PartTransform
Defines a PartTransform.

Declaration Syntax
public class PartTransform : DataModelObject, IFolderDataModelObject

Table 229: Members

Property Children (p. 734) Gets the list of children.

Property Comments (p. 734) Gets the list of associated comments.
Property CoordinateSystem (p. 734) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 734) Gets the current DataModelObject's category.
Property DefineBy (p. 735) Gets or sets the DefineBy.
Property Figures (p. 735) Gets the list of associated figures.
Property Images (p. 735) Gets the list of associated images.
Property InternalObject (p. 735) Gets the internal object. For advanced usage only.
Property Location (p. 735) Gets or sets the Location.
Property RotationX (p. 735) Gets or sets the RotationX.
Property RotationY (p. 736) Gets or sets the RotationY.
Property RotationZ (p. 736) Gets or sets the RotationZ.
Property ScopingMethod (p. 736) Gets or sets the ScopingMethod.
Property SourceCoordinateSystem (p. 736) Gets or sets the SourceCoordinateSystem.
Property Suppressed (p. 736) Gets or sets the Suppressed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 733
Ansys.ACT.Automation.Mechanical Namespace

Property TargetCoordinateSystem (p. 736) Gets or sets the TargetCoordinateSystem.

Property TranslationX (p. 737) Gets or sets the TranslationX.
Property TranslationY (p. 737) Gets or sets the TranslationY.
Property TranslationZ (p. 737) Gets or sets the TranslationZ.
Method AddComment() (p. 737) Creates a new child Comment.
Method AddFigure() (p. 737) Creates a new child Figure.
Method AddImage(string) (p. 737) 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. 738) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 738)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 738)
Method TransformGeometry() (p. 739) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
734 of ANSYS, Inc. and its subsidiaries and affiliates.
 PartTransform

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 735
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
736 of ANSYS, Inc. and its subsidiaries and affiliates.
 PartTransform

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.

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.

Release 2022 R2 - © 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 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
738 of ANSYS, Inc. and its subsidiaries and affiliates.
 PartTransformGroup

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()

PartTransformGroup
Defines a PartTransformGroup.

Declaration Syntax
public class PartTransformGroup : DataModelObject, IFolderDataModelObject

Table 230: Members

Property Children (p. 740) Gets the list of children.

Property Comments (p. 740) Gets the list of associated comments.
Property DataModelObjectCategory (p. 740) Gets the current DataModelObject's category.
Property Figures (p. 740) Gets the list of associated figures.
Property Images (p. 740) Gets the list of associated images.
Property InternalObject (p. 741) Gets the internal object. For advanced usage only.
Property RegenerateContacts (p. 741) Gets or sets the RegenerateContacts.
Property Suppressed (p. 741) Gets or sets the Suppressed.
Property TransformMesh (p. 741) Gets or sets the TransformMesh.
Method AddComment() (p. 741) Creates a new child Comment.
Method AddFigure() (p. 741) Creates a new child Figure.
Method AddImage(string) (p. 742) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 739
Ansys.ACT.Automation.Mechanical Namespace

image will be a screen capture of the Geometry

window.
Method AddPartTransform() (p. 742) Creates a new PartTransform
Method Delete() (p. 742) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 742)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 743)
Method TransformGeometry() (p. 743) 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; }

Images
Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
740 of ANSYS, Inc. and its subsidiaries and affiliates.
 PartTransformGroup

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 741
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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
742 of ANSYS, Inc. and its subsidiaries and affiliates.
 Path

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.

Declaration Syntax
public virtual void TransformGeometry()

Path
Defines a Path.

Declaration Syntax
public class Path : DataModelObject, ISelectionInfo, IFolderDataModelObject

Table 231: Members

Property Children (p. 744) Gets the list of children.

Property Comments (p. 745) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 743
Ansys.ACT.Automation.Mechanical Namespace

Property DataModelObjectCategory (p. 745) Gets the current DataModelObject's category.

Property DiscretizationPoints (p. 745) Gets or sets the DiscretizationPoints.
Property EndCoordinateSystem (p. 745) Gets or sets the EndCoordinateSystem.
Property EndXCoordinate (p. 745) Gets or sets the EndXCoordinate.
Property EndYCoordinate (p. 745) Gets or sets the EndYCoordinate.
Property EndZCoordinate (p. 746) Gets or sets the EndZCoordinate.
Property Figures (p. 746) Gets the list of associated figures.
Property HasValidGeometrySelection (p. 746) Gets the HasValidGeometrySelection.
Property Images (p. 746) Gets the list of associated images.
Property InternalObject (p. 746) Gets the internal object. For advanced usage only.
Property Location (p. 746) Gets or sets the Location.
Property NumberOfSamplingPoints (p. 747) Gets or sets the NumberOfSamplingPoints.
Property NumberOfSubpaths (p. 747) Gets or sets the NumberOfSubpaths.
Property OffsetEdgeLocation (p. 747) Gets or sets the OffsetEdgeLocation.
Property PathCoordinateSystem (p. 747) Gets or sets the PathCoordinateSystem.
Property PathType (p. 747) Gets or sets the PathType.
Property ShowMesh (p. 747) Gets or sets the ShowMesh.
Property SnapToMeshNodes (p. 748) Gets or sets the SnapToMeshNodes.
Property StartCoordinateSystem (p. 748) Gets or sets the StartCoordinateSystem.
Property StartXCoordinate (p. 748) Gets or sets the StartXCoordinate.
Property StartYCoordinate (p. 748) Gets or sets the StartYCoordinate.
Property StartZCoordinate (p. 748) Gets or sets the StartZCoordinate.
Property Suppressed (p. 748) Gets or sets the Suppressed.
Method AddComment() (p. 749) Creates a new child Comment.
Method AddFigure() (p. 749) Creates a new child Figure.
Method AddImage(string) (p. 749) 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. 749) Run the Delete action.
Method FlipPathOrientatation() (p. 749) Flip Path Orientatation
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 750)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 750)
Method SnapPathToMeshNodes() (p. 750) Snap path to mesh nodes

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
744 of ANSYS, Inc. and its subsidiaries and affiliates.
 Path

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 745
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public Quantity EndYCoordinate { set;get; }

EndZCoordinate
Gets or sets the EndZCoordinate.

Declaration Syntax
public Quantity EndZCoordinate { set;get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
746 of ANSYS, Inc. and its subsidiaries and affiliates.
 Path

Declaration Syntax
public ISelectionInfo Location { set;get; }

NumberOfSamplingPoints
Gets or sets the NumberOfSamplingPoints.

Declaration Syntax
public int NumberOfSamplingPoints { set;get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 747
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool ShowMesh { set;get; }

SnapToMeshNodes
Gets or sets the SnapToMeshNodes.

Declaration Syntax
public bool SnapToMeshNodes { set;get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
748 of ANSYS, Inc. and its subsidiaries and affiliates.
 Path

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()

FlipPathOrientatation()
Flip Path Orientatation

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 749
Ansys.ACT.Automation.Mechanical Namespace

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)

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
750 of ANSYS, Inc. and its subsidiaries and affiliates.
 PatternRepetitionConstraint

Declaration Syntax
public virtual void SnapPathToMeshNodes()

PatternRepetitionConstraint
Defines a PatternRepetitionConstraint.

Declaration Syntax
public class PatternRepetitionConstraint : ManufacturingConstraint

Table 232: Members

Property Axis (p. 751) Gets or sets the Axis.

Property Children (p. 556) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 556).)
Property CoordinateSystem (p. 751) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 752)Gets the current DataModelObject's
category.
Property InternalObject (p. 752) Gets the internal object. For advanced usage
only.
Property Location (p. 752) Gets or sets the Location.
Property Offset (p. 752) Gets or sets the Offset.
Property ScopingMethod (p. 752) Gets or sets the ScopingMethod.
Property Selection (p. 557) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 751
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
752 of ANSYS, Inc. and its subsidiaries and affiliates.
 PeriodicRegion

Declaration Syntax
public class PeriodicRegion : SymmetryGeneral

Table 233: Members

Property Children (p. 1006) Gets the list of children.

(Inherited from SymmetryGeneral (p. 1005).)

Property Comments (p. 1006) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1005).)

Property CoordinateSystem (p. 1006) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1005).)

Property DataModelObjectCategory (p. 753)Gets the current DataModelObject's
category.
Property Figures (p. 1006) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1005).)

Property HighBoundaryLocation (p. 1007) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1005).)

Property Images (p. 1007) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1005).)

Property InternalObject (p. 754) Gets the internal object. For advanced usage
only.
Property Location (p. 1007) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 1005).)

Property LowBoundaryLocation (p. 1007) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1005).)

Property ScopeMode (p. 1007) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1005).)

Property Suppressed (p. 1008) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1005).)

Property Type (p. 754) Gets or sets the Type.

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 753
Ansys.ACT.Automation.Mechanical Namespace

InternalObject
Gets the internal object. For advanced usage only.

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 234: Members

Property Acoustics (p. 755) Gets or sets the Acoustics.

Property ArtificiallyMatchedLayers (p. 755) Gets or sets the ArtificiallyMatchedLayers.
Property Children (p. 756) Gets the list of children.
Property DataModelObjectCategory (p. 756) Gets the current DataModelObject's
category.
Property Electric (p. 756) Gets or sets the Electric.
Property ElementMorphing (p. 756) Gets or sets the ElementMorphing.
Property EvanescentWaveAttenuation (p. 756) Gets or sets the
EvanescentWaveAttenuation.
Property FluidBehavior (p. 756) Gets or sets the FluidBehavior.
Property InternalObject (p. 757) Gets the internal object. For advanced
usage only.
Property Location (p. 757) Gets or sets the Location.
Property PMLElementCoordinateSystem (p. 757) Gets or sets the
PMLElementCoordinateSystem.
Property PMLOptions (p. 757) Gets or sets the PMLOptions.
Property ReferencePressure (p. 757) Gets or sets the ReferencePressure.
Property ReferenceStaticPressure (p. 757) Gets or sets the ReferenceStaticPressure.
Property ReflectionCoefficient (p. 758) Gets or sets the ReflectionCoefficient.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
754 of ANSYS, Inc. and its subsidiaries and affiliates.
 PhysicsRegion

Property ReflectionCoefficientInNegativeXDirection (p. 758) Gets or sets the

ReflectionCoefficientInNegativeXDirection.
Property ReflectionCoefficientInNegativeYDirection (p. 758) Gets or sets the
ReflectionCoefficientInNegativeYDirection.
Property ReflectionCoefficientInNegativeZDirection (p. 758) Gets or sets the
ReflectionCoefficientInNegativeZDirection.
Property ReflectionCoefficientInPositiveXDirection (p. 758) Gets or sets the
ReflectionCoefficientInPositiveXDirection.
Property ReflectionCoefficientInPositiveYDirection (p. 758) Gets or sets the
ReflectionCoefficientInPositiveYDirection.
Property ReflectionCoefficientInPositiveZDirection (p. 759) Gets or sets the
ReflectionCoefficientInPositiveZDirection.
Property ReflectionCoefficientsType (p. 759) Gets or sets the
ReflectionCoefficientsType.
Property Structural (p. 759) Gets or sets the Structural.
Property Suppressed (p. 759) Gets or sets the Suppressed.
Property Thermal (p. 759) Gets or sets the Thermal.
Property ThermalStrain (p. 759) Gets or sets the ThermalStrain.
Property ThermoelasticDamping (p. 760) Gets or sets the ThermoelasticDamping.
Method Delete() (p. 760) Run the Delete action.
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. 760)
Method RenameBasedOnDefinition() (p. 761) Run the RenameBasedOnDefinition
action.
Method SelectInvalidBodiesOnPhysicsRegion() (p. 761) Run the
SelectInvalidBodiesOnPhysicsRegion
action to select bodies that are not valid.

Acoustics
Gets or sets the Acoustics.

Declaration Syntax
public bool Acoustics { set;get; }

ArtificiallyMatchedLayers
Gets or sets the ArtificiallyMatchedLayers.

Declaration Syntax
public ArtificiallyMatchedLayers ArtificiallyMatchedLayers { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 755
Ansys.ACT.Automation.Mechanical Namespace

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; }

Electric
Gets or sets the Electric.

Declaration Syntax
public ElectricType Electric { 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; }

FluidBehavior
Gets or sets the FluidBehavior.

Declaration Syntax
public FluidBehavior FluidBehavior { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
756 of ANSYS, Inc. and its subsidiaries and affiliates.
 PhysicsRegion

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSPhysicsRegionAuto InternalObject { get; }

Location
Gets or sets the Location.

Declaration Syntax
public ISelectionInfo Location { set;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.

Declaration Syntax
public Quantity ReferenceStaticPressure { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 757
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public double ReflectionCoefficientInPositiveYDirection { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
758 of ANSYS, Inc. and its subsidiaries and affiliates.
 PhysicsRegion

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.

Declaration Syntax
public ThermalStrainType ThermalStrain { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 759
Ansys.ACT.Automation.Mechanical Namespace

ThermoelasticDamping
Gets or sets the ThermoelasticDamping.

Declaration Syntax
public ThermoelasticDampingType ThermoelasticDamping { 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
760 of ANSYS, Inc. and its subsidiaries and affiliates.
 PipeIdealization

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()

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 235: Members

Property Children (p. 762) Gets the list of children.

Property DataModelObjectCategory (p. 762) Gets the current DataModelObject's
category.
Property Extend (p. 762) Gets or sets the Extend.
Property Factor (p. 762) Gets or sets the Factor.
Property GeometrySelection (p. 762) Gets or sets the GeometrySelection.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 761
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 763) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 763) Gets or sets the Suppressed.
Method Delete() (p. 763) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 763)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 764)

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
762 of ANSYS, Inc. and its subsidiaries and affiliates.
 PipeIdealization

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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 763
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.)

PointMass
Defines a PointMass.

Declaration Syntax
public class PointMass : GenericPointMass

Table 236: Members

Property AppliedBy (p. 765) Gets or sets the AppliedBy.

Property BeamRadius (p. 765) Gets or sets the BeamRadius.
Property Behavior (p. 766) Gets or sets the Behavior.
Property Children (p. 425) Gets the list of children.

(Inherited from GenericPointMass (p. 424).)

Property Comments (p. 425) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 424).)

Property CoordinateSystem (p. 766) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 766) Gets the current DataModelObject's category.
Property Figures (p. 425) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 424).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
764 of ANSYS, Inc. and its subsidiaries and affiliates.
 PointMass

Property Images (p. 426) Gets the list of associated images.

(Inherited from GenericPointMass (p. 424).)

Property InternalObject (p. 766) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 426) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 424).)

Property Location (p. 426) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 424).)

Property Mass (p. 766)
Property MassMomentOfInertiaX (p. 766)
Property MassMomentOfInertiaY (p. 767)
Property MassMomentOfInertiaZ (p. 767)
Property Material (p. 767)
Property NodalCoordinateSystem (p. 767)
Property PinballRegion (p. 767)
Property RemotePoint (p. 426)
Gets or sets the Mass.
Gets or sets the MassMomentOfInertiaX.
Gets or sets the MassMomentOfInertiaY.
Gets or sets the MassMomentOfInertiaZ.
Gets or sets the Material.
Gets the NodalCoordinateSystem.
Gets or sets the PinballRegion.
Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 424).)

Property Suppressed (p. 767) Gets or sets the Suppressed.
Property XCoordinate (p. 768) Gets or sets the XCoordinate.
Property YCoordinate (p. 768) Gets or sets the YCoordinate.
Property ZCoordinate (p. 768) Gets or sets the ZCoordinate.
Method PromoteToRemotePoint() (p. 768) 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 765
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
766 of ANSYS, Inc. and its subsidiaries and affiliates.
 PointMass

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 767
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual IEnumerable<RemotePoint> PromoteToRemotePoint()

PostContactTool
Defines a PostContactTool.

Declaration Syntax
public class PostContactTool : PreContactTool

Table 237: Members

Property Children (p. 3182) Gets the list of children.

(Inherited from ContactTool (p. 3182).)

Property Comments (p. 3183) Gets the list of associated comments.

(Inherited from ContactTool (p. 3182).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
768 of ANSYS, Inc. and its subsidiaries and affiliates.
 PostContactTool

Property DataModelObjectCategory (p. 769)Gets the current DataModelObject's

category.
Property Figures (p. 3183) Gets the list of associated figures.

(Inherited from ContactTool (p. 3182).)

Property Images (p. 3183) Gets the list of associated images.

(Inherited from ContactTool (p. 3182).)

Property InternalObject (p. 769) Gets the internal object. For advanced usage
only.
Property Location (p. 3183) Gets or sets the Location.

(Inherited from ContactTool (p. 3182).)

Property ScopingMethod (p. 3184) Gets or sets the ScopingMethod.

(Inherited from ContactTool (p. 3182).)

Method AddFluidPressure() (p. 769)
Method AddFrictionalStress() (p. 770)
Method AddHeatFlux() (p. 770)
Method AddPressure() (p. 770)
Method AddSlidingDistance() (p. 770)
Creates a new ContactFluidPressure
Creates a new ContactFrictionalStress
Creates a new ContactHeatFlux
Creates a new ContactPressure
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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 769
Ansys.ACT.Automation.Mechanical Namespace

AddFrictionalStress()
Creates a new ContactFrictionalStress

Declaration Syntax
public virtual ContactFrictionalStress AddFrictionalStress()

AddHeatFlux()
Creates a new ContactHeatFlux

Declaration Syntax
public virtual ContactHeatFlux AddHeatFlux()

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 238: Members

Property Children (p. 3182) Gets the list of children.

(Inherited from ContactTool (p. 3182).)

Property Comments (p. 3183) Gets the list of associated comments.

(Inherited from ContactTool (p. 3182).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
770 of ANSYS, Inc. and its subsidiaries and affiliates.
 PreContactTool

Property DataModelObjectCategory (p. 771)Gets the current DataModelObject's

category.
Property Figures (p. 3183) Gets the list of associated figures.

(Inherited from ContactTool (p. 3182).)

Property Images (p. 3183) Gets the list of associated images.

(Inherited from ContactTool (p. 3182).)

Property InternalObject (p. 771) Gets the internal object. For advanced usage
only.
Property Location (p. 3183) Gets or sets the Location.

(Inherited from ContactTool (p. 3182).)

Property ScopingMethod (p. 3184) Gets or sets the ScopingMethod.

(Inherited from ContactTool (p. 3182).)

Method AddGap() (p. 771) Creates a new ContactGap
Method AddInitialInformation() (p. 772) Creates a new ContactDataTable
Method AddPenetration() (p. 772) Creates a new ContactPenetration
Method AddStatus() (p. 772) 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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 771
Ansys.ACT.Automation.Mechanical Namespace

AddInitialInformation()
Creates a new ContactDataTable

Declaration Syntax
public virtual ContactDataTable AddInitialInformation()

AddPenetration()
Creates a new ContactPenetration

Declaration Syntax
public virtual ContactPenetration AddPenetration()

AddStatus()
Creates a new ContactStatus

Declaration Syntax
public virtual ContactStatus AddStatus()

PreMeshedCrack
Defines a PreMeshedCrack.

Declaration Syntax
public class PreMeshedCrack : GenericCrack

Table 239: Members

Property BottomFaceNodes (p. 773) Gets or sets the BottomFaceNodes.

Property Children (p. 418) Gets the list of children.

(Inherited from GenericCrack (p. 417).)

Property Comments (p. 418) Gets the list of associated comments.

(Inherited from GenericCrack (p. 417).)

Property CoordinateSystem (p. 773)
Property CrackFacesNodes (p. 773)
Property CrackFront (p. 773)
Property CrackSourceType (p. 774)
Property CrackSymmetry (p. 774)
Gets or sets the CoordinateSystem.
Gets or sets the CrackFacesNodes.
Gets or sets the CrackFront.
Gets the CrackSourceType.
Gets or sets the CrackSymmetry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
772 of ANSYS, Inc. and its subsidiaries and affiliates.
 PreMeshedCrack

Property DataModelObjectCategory (p. 774) Gets the current DataModelObject's

category.
Property Figures (p. 418) Gets the list of associated figures.

(Inherited from GenericCrack (p. 417).)

Property Images (p. 418) Gets the list of associated images.

(Inherited from GenericCrack (p. 417).)

Property InternalObject (p. 774) Gets the internal object. For advanced usage
only.
Property ScopingMethod (p. 774) Gets the ScopingMethod.
Property SolutionContours (p. 774) Gets or sets the SolutionContours.
Property Suppressed (p. 775) Gets or sets the Suppressed.
Property TopFaceNodes (p. 775) 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 773
Ansys.ACT.Automation.Mechanical Namespace

CrackSourceType
Gets the CrackSourceType.

Declaration Syntax
public CrackSourceType CrackSourceType { get; }

CrackSymmetry
Gets or sets the CrackSymmetry.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
774 of ANSYS, Inc. and its subsidiaries and affiliates.
 PreMeshedCyclicRegion

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

TopFaceNodes
Gets or sets the TopFaceNodes.

Declaration Syntax
public NamedSelection TopFaceNodes { set;get; }

PreMeshedCyclicRegion
Defines a PreMeshedCyclicRegion.

Declaration Syntax
public class PreMeshedCyclicRegion : SymmetryGeneral

Table 240: Members

Property BoundaryDOFOrientation (p. 776) Gets or sets the BoundaryDOFOrientation.

Property Children (p. 1006) Gets the list of children.

(Inherited from SymmetryGeneral (p. 1005).)

Property Comments (p. 1006) Gets the list of associated comments.

(Inherited from SymmetryGeneral (p. 1005).)

Property CoordinateSystem (p. 1006) Gets or sets the CoordinateSystem.

(Inherited from SymmetryGeneral (p. 1005).)

Property DataModelObjectCategory (p. 776)Gets the current DataModelObject's
category.
Property Figures (p. 1006) Gets the list of associated figures.

(Inherited from SymmetryGeneral (p. 1005).)

Property HighBoundaryLocation (p. 1007) Gets or sets the HighBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1005).)

Property Images (p. 1007) Gets the list of associated images.

(Inherited from SymmetryGeneral (p. 1005).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 775
Ansys.ACT.Automation.Mechanical Namespace

Property InternalObject (p. 776) Gets the internal object. For advanced usage
only.
Property Location (p. 1007) Gets or sets the Location.

(Inherited from SymmetryGeneral (p. 1005).)

Property LowBoundaryLocation (p. 1007) Gets or sets the LowBoundaryLocation.

(Inherited from SymmetryGeneral (p. 1005).)

Property NumberOfSectors (p. 776) Gets or sets the NumberOfSectors.
Property RelativeDistanceTolerance (p. 777) Gets or sets the RelativeDistanceTolerance.
Property ScopeMode (p. 1007) Gets the ScopeMode.

(Inherited from SymmetryGeneral (p. 1005).)

Property Suppressed (p. 1008) Gets or sets the Suppressed.

(Inherited from SymmetryGeneral (p. 1005).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
776 of ANSYS, Inc. and its subsidiaries and affiliates.
 PrimaryCriterion

Declaration Syntax
public int NumberOfSectors { set;get; }

RelativeDistanceTolerance
Gets or sets the RelativeDistanceTolerance.

Declaration Syntax
public double RelativeDistanceTolerance { set;get; }

PrimaryCriterion
Defines a PrimaryCriterion.

Declaration Syntax
public class PrimaryCriterion : Criterion

Table 241: Members

Property BaseResult (p. 778) Gets or sets the BaseResult.

Property BoundaryCondition (p. 778) Gets or sets the BoundaryCondition.
Property Children (p. 318) Gets the list of children.

(Inherited from Criterion (p. 317).)

Property Comments (p. 318) Gets the list of associated comments.

(Inherited from Criterion (p. 317).)

Property DataModelObjectCategory (p. 778) Gets the current DataModelObject's
category.
Property DirectionX (p. 778) Gets or sets the DirectionX.
Property DirectionY (p. 779) Gets or sets the DirectionY.
Property DirectionZ (p. 779) Gets or sets the DirectionZ.
Property Figures (p. 318) Gets the list of associated figures.

(Inherited from Criterion (p. 317).)

Property Images (p. 318) Gets the list of associated images.

(Inherited from Criterion (p. 317).)

Property InternalObject (p. 779) Gets the internal object. For advanced usage
only.
Property Location (p. 779) Gets or sets the Location.
Property LocationMethod (p. 779) Gets or sets the LocationMethod.
Property ModeNumber (p. 779) Gets or sets the ModeNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 777
Ansys.ACT.Automation.Mechanical Namespace

Property ReferenceType (p. 780) Gets or sets the ReferenceType.

Property RemotePoint (p. 780) Gets or sets the RemotePoint.
Property RobustFrequenciesReduction (p. 780) Gets or sets the
RobustFrequenciesReduction.
Property SpatialReduction (p. 780) Gets or sets the SpatialReduction.
Property SpatialReductionMethod (p. 780) Gets or sets the SpatialReductionMethod.
Property Step (p. 780) Gets or sets the Step.
Property Suppressed (p. 319) Gets or sets the Suppressed.

(Inherited from Criterion (p. 317).)

Property Value (p. 781) Gets the Value.
Property VectorReduction (p. 781) Gets or sets the VectorReduction.
Method ClearGeneratedData() (p. 781) Run the ClearGeneratedData action.
Method EvaluateAllResults() (p. 781) Run the EvaluateAllResults 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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
778 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; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSTopoCriterionAuto InternalObject { get; }

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; }

ModeNumber
Gets or sets the ModeNumber.

Declaration Syntax
public int ModeNumber { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 779
Ansys.ACT.Automation.Mechanical Namespace

ReferenceType
Gets or sets the ReferenceType.

Declaration Syntax
public VectorReductionReferenceType ReferenceType { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
780 of ANSYS, Inc. and its subsidiaries and affiliates.
 Project

Value
Gets the Value.

Declaration Syntax
public Quantity Value { get; }

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()

Project
Defines a Project.

Declaration Syntax
public class Project : DataModelObject, IFolderDataModelObject

Table 242: Members

Property Author (p. 782) Gets or sets the Author.

Property Children (p. 783) Gets the list of children.
Property Comments (p. 783) Gets the list of associated comments.
Property CreationDate (p. 783) Gets the CreationDate.
Property CreationTime (p. 783) Gets the CreationTime.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 781
Ansys.ACT.Automation.Mechanical Namespace

Property DataModelObjectCategory (p. 783) Gets the current DataModelObject's category.

Property FirstSaved (p. 783) Gets the FirstSaved.
Property Images (p. 784) Gets the list of associated images.
Property ImportedSource (p. 784) Gets the ImportedSource.
Property ImportedVersion (p. 784) Gets the ImportedVersion.
Property InternalObject (p. 784) Gets the internal object. For advanced usage
only.
Property LastSaved (p. 784) Gets the LastSaved.
Property Model (p. 784) Gets the Model.
Property Models ***OBSOLETE*** Use 'Model' Gets the Model.
property instead. (p. 785)
Property PreparedFor (p. 785) Gets or sets the PreparedFor.
Property ProductVersion (p. 785) Gets the ProductVersion.
Property SaveProjectAfterSolution (p. 785) Gets or sets the SaveProjectAfterSolution.
Property SaveProjectBeforeSolution (p. 785) Gets or sets the SaveProjectBeforeSolution.
Property Subject (p. 785) Gets or sets the Subject.
Property UnitSystem (p. 786) Change the Unit System.
Method AddComment() (p. 786) Creates a new child Comment.
Method AddImage(string) (p. 786) 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. 786) Run the ClearGeneratedData action.
Method CombineTextFiles(string, string) (p. 786) 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. 787)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 787)
Method SpecifyMetricTemperatureInCelsius() (p. 788) Specify the use of Celsius thermal units for
metric unit systems.
Method SpecifyMetricTemperatureInKelvin() (p. 788) Specify the use of Kelvin thermal units for
metric unit systems.

Author
Gets or sets the Author.

Declaration Syntax
public string Author { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
782 of ANSYS, Inc. and its subsidiaries and affiliates.
 Project

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.

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; }

FirstSaved
Gets the FirstSaved.

Declaration Syntax
public string FirstSaved { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 783
Ansys.ACT.Automation.Mechanical Namespace

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

ImportedSource
Gets the ImportedSource.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
784 of ANSYS, Inc. and its subsidiaries and affiliates.
 Project

Models ***OBSOLETE*** Use 'Model' property instead.

Gets the Model.

Declaration Syntax
public IEnumerable<Model> Models { get; }

PreparedFor
Gets or sets the PreparedFor.

Declaration Syntax
public string PreparedFor { set;get; }

ProductVersion
Gets the ProductVersion.

Declaration Syntax
public string ProductVersion { 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 785
Ansys.ACT.Automation.Mechanical Namespace

UnitSystem
Change the Unit System.

Declaration Syntax
public UserUnitSystemType UnitSystem { 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()

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
786 of ANSYS, Inc. and its subsidiaries and affiliates.
 Project

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)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 787
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.)

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()

PullOutDirectionManufacturingConstraint
Defines a PullOutDirectionManufacturingConstraint.

Declaration Syntax
public class PullOutDirectionManufacturingConstraint : ManufacturingConstraint

Table 243: Members

Property Axis (p. 789) Gets or sets the Axis.

Property Children (p. 556) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 556).)
Property CoordinateSystem (p. 789) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 789)Gets the current DataModelObject's
category.
Property Direction (p. 789) Gets or sets the Direction.
Property InternalObject (p. 789) Gets the internal object. For advanced usage
only.
Property Location (p. 790) Gets or sets the Location.
Property ScopingMethod (p. 790) Gets or sets the ScopingMethod.
Property Selection (p. 557) Gets or sets the Selection.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
788 of ANSYS, Inc. and its subsidiaries and affiliates.
 PullOutDirectionManufacturingConstraint

(Inherited from
ManufacturingConstraint (p. 556).)
Property Subtype (p. 790) Gets or sets the Subtype.
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

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.

Declaration Syntax
public IDSTopoConstraintAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 789
Ansys.ACT.Automation.Mechanical Namespace

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 244: Members

Property Connected (p. 791) Gets whether the callbacks are currently connected.
Property DataModelObjectCategory (p. 791)Gets the current DataModelObject's category.
Property InternalObject (p. 791) Gets the internal object. For advanced usage only.
Property PropertyProvider (p. 791) Gets or sets the propperty provider instance associated
with this python code object.
Property ScriptExecutionScope (p. 791) The scope identifier in which the code execution will
take place.
Property Text (p. 791) Gets or sets the text in the script tab for the Python Code
object.
Method Connect() (p. 792) Register the python code.
Method Delete() (p. 792) Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
790 of ANSYS, Inc. and its subsidiaries and affiliates.
 PythonCode

Method ReloadProperties() (p. 792) Reload properties to update properties provided by the
provider.

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 791
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public class PythonCodeEventBased : PythonCode

Table 245: Members

Property Connected (p. 791) Gets whether the callbacks are currently connected.

(Inherited from PythonCode (p. 790).)

Property DataModelObjectCategory (p. 793)Gets the current DataModelObject's category.
Property InternalObject (p. 793) Gets the internal object. For advanced usage only.
Property InternalObject (p. 791) Gets the internal object. For advanced usage only.

(Inherited from PythonCode (p. 790).)

Property PropertyProvider (p. 791) Gets or sets the propperty provider instance associated
with this python code object.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
792 of ANSYS, Inc. and its subsidiaries and affiliates.
 PythonCodeEventBased

(Inherited from PythonCode (p. 790).)

Property ScriptExecutionScope (p. 791) The scope identifier in which the code execution will
take place.

(Inherited from PythonCode (p. 790).)

Property SolverTarget (p. 793) Gets the SolverTarget.
Property Suppressed (p. 793) Gets or sets the Suppressed.
Property TargetCallback (p. 794) Gets or sets the TargetCallback.
Property Text (p. 791) Gets or sets the text in the script tab for the Python Code
object.

(Inherited from PythonCode (p. 790).)

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 IDSPythonCodeEventBasedAuto InternalObject { get; }

SolverTarget
Gets the SolverTarget.

Declaration Syntax
public CommandEditorTarget SolverTarget { get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 793
Ansys.ACT.Automation.Mechanical Namespace

TargetCallback
Gets or sets the TargetCallback.

Declaration Syntax
public PythonCodeTargetCallback TargetCallback { set;get; }

ReactionForceConstraint
Defines a ReactionForceConstraint.

Declaration Syntax
public class ReactionForceConstraint : ResponseConstraint

Table 246: Members

Property AxisSelection (p. 794) Gets or sets the AxisSelection.

Property BoundType (p. 795) Gets or sets the BoundType.
Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 795) Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 795)
Property Location (p. 795)
Property ReactionForceCriteria (p. 795)
Property ScopingMethod (p. 795)
Property Suppressed (p. 810)
Gets the internal object. For advanced usage only.
Gets or sets the Location.
Gets or sets the ReactionForceCriteria.
Gets or sets the ScopingMethod.
Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

Property XComponentMax (p. 796) Gets or sets the XComponentMax.
Property YComponentMax (p. 796) Gets or sets the YComponentMax.
Property ZComponentMax (p. 796) Gets or sets the ZComponentMax.

AxisSelection
Gets or sets the AxisSelection.

Declaration Syntax
public AxisSelectionType AxisSelection { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
794 of ANSYS, Inc. and its subsidiaries and affiliates.
 ReactionForceConstraint

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 795
Ansys.ACT.Automation.Mechanical Namespace

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; }

RectangularCrossSection
Defines a RectangularCrossSection.

Declaration Syntax
public class RectangularCrossSection : CrossSection

Table 247: Members

Property Area (p. 797) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 797)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Height (p. 797) Gets or sets the Height.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
796 of ANSYS, Inc. and its subsidiaries and affiliates.
 RectangularCrossSection

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 797) Gets the internal object. For advanced usage
only.
Property IYY (p. 797) Gets the IYY.
Property IZZ (p. 798) Gets the IZZ.
Property Width (p. 798) Gets or sets the Width.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

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.

Release 2022 R2 - © 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 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.

Declaration Syntax
public class RemotePoint : ImportedDataModelObject, ISelectionInfo, IFolderDataModelObject

Table 248: Members

Property Behavior (p. 799) Gets or sets the Behavior.

Property Children (p. 799) Gets the list of children.
Property Comments (p. 799) Gets the list of associated comments.
Property CoordinateSystem (p. 800) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 800) Gets the current DataModelObject's category.
Property DOFSelection (p. 800) Gets or sets the DOFSelection.
Property GloballyAvailable (p. 800) Remote point is globally available
Property InternalObject (p. 800) Gets the internal object. For advanced usage only.
Property Location (p. 800) Gets or sets the Location.
Property Material (p. 801) Gets or sets the Material.
Property OutlineSelection (p. 801) Gets or sets the OutlineSelection.
Property PilotNodeAPDLName (p. 801) Gets or sets the PilotNodeAPDLName.
Property PilotNodeScopingType (p. 801) Gets or sets the PilotNodeScopingType.
Property PinballRegion (p. 801) Gets or sets the PinballRegion.
Property Point (p. 801) Gets or sets the Point.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
798 of ANSYS, Inc. and its subsidiaries and affiliates.
 RemotePoint

Property Radius (p. 802) Gets or sets the Radius.

Property RelaxationMethod (p. 802) Gets or sets the RelaxationMethod.
Property RotationX (p. 802) Gets or sets the RotationX.
Property RotationY (p. 802) Gets or sets the RotationY.
Property RotationZ (p. 802) Gets or sets the RotationZ.
Property ScopingMethod (p. 802) Gets or sets the ScopingMethod.
Property Suppressed (p. 803) Gets or sets the Suppressed.
Property XComponent (p. 803) Gets or sets the XComponent.
Property XCoordinate (p. 803) Gets or sets the XCoordinate.
Property YComponent (p. 803) Gets or sets the YComponent.
Property YCoordinate (p. 803) Gets or sets the YCoordinate.
Property ZComponent (p. 803) Gets or sets the ZComponent.
Property ZCoordinate (p. 804) Gets or sets the ZCoordinate.
Method AddCommandSnippet() (p. 804) Creates a new CommandSnippet
Method AddComment() (p. 804) Creates a new child Comment.
Method Delete() (p. 804) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 804)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 805)
Method GetMeshRegion() (p. 805) Returns the mesh region associated to the remote
point.
Method PromoteToNamedSelection() (p. 805) 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 799
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; }

DOFSelection
Gets or sets the DOFSelection.

Declaration Syntax
public RemotePointDOFSelectionType DOFSelection { 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
800 of ANSYS, Inc. and its subsidiaries and affiliates.
 RemotePoint

Declaration Syntax
public ISelectionInfo Location { set;get; }

Material
Gets or sets the Material.

Declaration Syntax
public string Material { set;get; }

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.

Release 2022 R2 - © 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 ConstructionPoint Point { set;get; }

Radius
Gets or sets the Radius.

Declaration Syntax
public Quantity Radius { set;get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
802 of ANSYS, Inc. and its subsidiaries and affiliates.
 RemotePoint

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

Suppressed
Gets or sets the Suppressed.

Declaration Syntax
public bool Suppressed { set;get; }

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.

Release 2022 R2 - © 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 ActiveOrInactive ZComponent { set;get; }

ZCoordinate
Gets or sets the ZCoordinate.

Declaration Syntax
public Quantity ZCoordinate { 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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
804 of ANSYS, Inc. and its subsidiaries and affiliates.
 RemotePoint

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.)

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 805
Ansys.ACT.Automation.Mechanical Namespace

RemotePoints
Defines a RemotePoints.

Defines a RemotePoints.

Declaration Syntax
public class RemotePoints : DataModelObject, IFolderDataModelObject

Table 249: Members

Property Children (p. 806) Gets the list of children.

Property Comments (p. 806) Gets the list of associated comments.
Property DataModelObjectCategory (p. 807) Gets the current DataModelObject's category.
Property Figures (p. 807) Gets the list of associated figures.
Property Images (p. 807) Gets the list of associated images.
Property InternalObject (p. 807) Gets the internal object. For advanced usage only.
Method AddComment() (p. 807) Creates a new child Comment.
Method AddFigure() (p. 807) Creates a new child Figure.
Method AddImage(string) (p. 808) 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. 808) Creates a new RemotePoint
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 808)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 808)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
806 of ANSYS, Inc. and its subsidiaries and affiliates.
 RemotePoints

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 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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 807
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
808 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResponseConstraint

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.)

ResponseConstraint
Defines a ResponseConstraint.

Declaration Syntax
public abstract class ResponseConstraint : DataModelObject, IFolderDataModelObject

Table 250: Members

Property Children (p. 809) Gets the list of children.

Property DataModelObjectCategory (p. 810) Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an
Analysis object or TopoEnvironmentType
enum.
Property InternalObject (p. 810) Gets the internal object. For advanced usage
only.
Property Suppressed (p. 810) Gets or sets the Suppressed.
Method Delete() (p. 810) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 810)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 811)
Method RenameBasedOnDefinition() (p. 811) Run the RenameBasedOnDefinition action.

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 809
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public IList<IDataModelObject> Children { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
810 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResponseConstraint

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 811
Ansys.ACT.Automation.Mechanical Namespace

ResponsePSDTool
Defines a ResponsePSDTool.

Declaration Syntax
public class ResponsePSDTool : DataModelObject, IFolderDataModelObject

Table 251: Members

Property Children (p. 812) Gets the list of children.

Property ClusteringFrequencyPoints (p. 812) Gets or sets the ClusteringFrequencyPoints.
Property Comments (p. 813) Gets the list of associated comments.
Property DataModelObjectCategory (p. 813) Gets the current DataModelObject's category.
Property Figures (p. 813) Gets the list of associated figures.
Property Images (p. 813) Gets the list of associated images.
Property IncludeAllExcitationFrequencies (p. 813) Gets or sets the IncludeAllExcitationFrequencies.
Property IncludeUserDefinedFrequencies (p. 813) Gets or sets the IncludeUserDefinedFrequencies.
Property InternalObject (p. 814) Gets the internal object. For advanced usage only.
Method AddComment() (p. 814) 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 AddResponsePSD() (p. 814) Creates a new ResponsePSD
Method Delete() (p. 815) Run the Delete action.
Method EvaluateAllResults() (p. 815) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 815)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 815)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

ClusteringFrequencyPoints
Gets or sets the ClusteringFrequencyPoints.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
812 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResponsePSDTool

Declaration Syntax
public int ClusteringFrequencyPoints { set;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; }

IncludeAllExcitationFrequencies
Gets or sets the IncludeAllExcitationFrequencies.

Declaration Syntax
public bool IncludeAllExcitationFrequencies { set;get; }

IncludeUserDefinedFrequencies
Gets or sets the IncludeUserDefinedFrequencies.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 813
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public bool IncludeUserDefinedFrequencies { set;get; }

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
814 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResponsePSDTool

Declaration Syntax
public virtual ResponsePSD AddResponsePSD()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 815
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.)

ResultMesh
Defines a ResultMesh.

Declaration Syntax
public class ResultMesh : DataModelObject, IFolderDataModelObject

Table 252: Members

Property Children (p. 817) Gets the list of children.

Property Comments (p. 817) Gets the list of associated comments.
Property ConfigurationId (p. 817) Gets the ConfigurationId.
Property DataModelObjectCategory (p. 817) Gets the current DataModelObject's category.
Property Elements (p. 817) Gets the Elements.
Property FEBodies (p. 818) Gets FE Bodies
Property Figures (p. 818) Gets the list of associated figures.
Property Images (p. 818) Gets the list of associated images.
Property InternalObject (p. 818) Gets the internal object. For advanced usage
only.
Property Nodes (p. 818) Gets the Nodes.
Property SourceFile (p. 818) Gets the SourceFile.
Property Suppressed (p. 819) Gets or sets the Suppressed.
Method AddComment() (p. 819) Creates a new child Comment.
Method AddFigure() (p. 819) Creates a new child Figure.
Method AddImage(string) (p. 819) 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. 819) Creates a new NamedSelection
Method ClearGeneratedData() (p. 820) Clear the generated mesh data

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
816 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultMesh

Method Generate() (p. 820) Generate the mesh data

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 820)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 820)
Method ImportComponentsFromResultFile() (p. 821) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 817
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
818 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultMesh

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 819
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
820 of ANSYS, Inc. and its subsidiaries and affiliates.
 RingCrack

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 253: Members

Property BottomFaceNodes (p. 822) Gets or sets the BottomFaceNodes.

Property Children (p. 418) Gets the list of children.

(Inherited from GenericCrack (p. 417).)

Property CircumferentialDivisions (p. 822) Gets or sets the CircumferentialDivisions.
Property Comments (p. 418) Gets the list of associated comments.

(Inherited from GenericCrack (p. 417).)

Property Contact1Nodes (p. 823)
Property ContactPairsNodes (p. 823)
Property CoordinateSystem (p. 823)
Property CrackFacesNodes (p. 823)
Property CrackFrontNodes (p. 823)
Property CrackMeshMethod (p. 823)
Property CrackShape (p. 824)
Gets or sets the Contact1Nodes.
Gets or sets the ContactPairsNodes.
Gets or sets the CoordinateSystem.
Gets or sets the CrackFacesNodes.
Gets or sets the CrackFrontNodes.
Gets or sets the CrackMeshMethod.
Gets the CrackShape.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 821
Ansys.ACT.Automation.Mechanical Namespace

Property CrackSourceType (p. 824) Gets the CrackSourceType.

Property DataModelObjectCategory (p. 824) Gets the current DataModelObject's
category.
Property Figures (p. 418) Gets the list of associated figures.

(Inherited from GenericCrack (p. 417).)

Property FractureAffectedZone (p. 824) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 824) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 824) Gets or sets the FrontElementSize.
Property GrowthRate (p. 825) Gets or sets the GrowthRate.
Property Images (p. 418) Gets the list of associated images.

(Inherited from GenericCrack (p. 417).)

Property InnerCrackFrontDivisions (p. 825) Gets or sets the InnerCrackFrontDivisions.
Property InnerMajorRadius (p. 825) Gets or sets the InnerMajorRadius.
Property InnerMinorRadius (p. 825) Gets or sets the InnerMinorRadius.
Property InternalObject (p. 825) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 825) Gets or sets the LargestContourRadius.
Property Location (p. 826) Gets or sets the Location.
Property MajorRadius (p. 826) Gets or sets the MajorRadius.
Property MeshContours (p. 826) Gets or sets the MeshContours.
Property MinorRadius (p. 826) Gets or sets the MinorRadius.
Property OuterCrackFrontDivisions (p. 826) Gets or sets the OuterCrackFrontDivisions.
Property SolutionContours (p. 826) Gets or sets the SolutionContours.
Property Suppressed (p. 827) Gets or sets the Suppressed.
Property Target1Nodes (p. 827) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 827) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 827) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 827) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 827) Gets or sets the ZScaleFactor.

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Declaration Syntax
public string BottomFaceNodes { set;get; }

CircumferentialDivisions
Gets or sets the CircumferentialDivisions.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
822 of ANSYS, Inc. and its subsidiaries and affiliates.
 RingCrack

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.

Declaration Syntax
public string CrackFrontNodes { set;get; }

CrackMeshMethod
Gets or sets the CrackMeshMethod.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 823
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public Quantity FractureAffectedZoneHeight { set;get; }

FrontElementSize
Gets or sets the FrontElementSize.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
824 of ANSYS, Inc. and its subsidiaries and affiliates.
 RingCrack

Declaration Syntax
public Quantity FrontElementSize { 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; }

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.

Declaration Syntax
public IDSCrackAuto InternalObject { get; }

LargestContourRadius
Gets or sets the LargestContourRadius.

Release 2022 R2 - © 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 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; }

OuterCrackFrontDivisions
Gets or sets the OuterCrackFrontDivisions.

Declaration Syntax
public int OuterCrackFrontDivisions { set;get; }

SolutionContours
Gets or sets the SolutionContours.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
826 of ANSYS, Inc. and its subsidiaries and affiliates.
 RingCrack

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; }

ZScaleFactor
Gets or sets the ZScaleFactor.

Release 2022 R2 - © 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 double ZScaleFactor { set;get; }

SelectionWorksheet
No details are provided for this entry.

Declaration Syntax
public class SelectionWorksheet : Worksheet, ISelectionInfo

Table 254: Members

Property RowCount (p. 829) No details are provided for this entry.
Method AddRow() (p. 830) Adds a Row to the worksheet.
Method DeleteRow(int) (p. 830) Deletes a row from the worksheet at
index.
Method Generate() (p. 830) Generate the selection from the
worksheet.
Method GetAction(int) (p. 830) Gets the worksheet Action property at
index.
Method GetBodyTypeValue(int) (p. 830) Gets the worksheet Body Type Value
property at index.
Method GetCoordinateSystemSelection(int) (p. 831) Gets the worksheet
CoordinateSystemSelection property at
index.
Method GetCriterion(int) (p. 831) Gets the worksheet Criterion property
at index.
Method GetCriterionActive(int) (p. 831) Gets the worksheet CriterionActive
property at index.
Method GetEdgeTypeValue(int) (p. 832) Gets the worksheet Edge Type Value
property at index.
Method GetFaceTypeValue(int) (p. 832) Gets the worksheet Face Type Value
property at index.
Method GetGeometryType(int) (p. 832) Gets the worksheet GeometryType
property at index.
Method GetLowerBound(int) (p. 833) Gets the worksheet LowerBound
property at index.
Method GetMeshElementTypeValue(int) (p. 833) Gets the worksheet Mesh Element Type
Value property at index.
Method GetOperator(int) (p. 833) Gets the worksheet Operator property
at index.
Method GetStringValue(int) (p. 833) Gets the worksheet StringValue
property at index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
828 of ANSYS, Inc. and its subsidiaries and affiliates.
 SelectionWorksheet

Method GetTag(uint) (p. 834) Gets the worksheet Tag property at

index.
Method GetUpperBound(int) (p. 834) Gets the worksheet UpperBound
property at index.
Method GetValue(int) (p. 834) Gets the worksheet Value property at
index.
Method SetAction(int, Sets the worksheet Action property at
NamedSelectionWorksheetAction) (p. 835) index.
Method SetBodyTypeValue(int, Sets the worksheet Body Type Value
NamedSelectionWorksheetBodyTypeValues) (p. 835) property at index.
Method SetCoordinateSystemSelection(int, uint) (p. 835) Sets the worksheet
CoordinateSystemSelection property at
index.
Method SetCriterion(int, Sets the worksheet Criterion property
NamedSelectionWorksheetCriterion) (p. 836) at index.
Method SetCriterionActive(int, bool) (p. 836) Sets the worksheet CriterionActive
property at index.
Method SetEdgeTypeValue(int, Sets the worksheet Edge Type Value
NamedSelectionWorksheetEdgeTypeValues) (p. 836) property at index.
Method SetEntityType(int, Sets the worksheet GeometryType
NamedSelectionWorksheetEntityType) (p. 837) property at index.
Method SetFaceTypeValue(int, Sets the worksheet Face Type Value
NamedSelectionWorksheetFaceTypeValues) (p. 837) property at index.
Method SetLowerBound(int, double) (p. 837) Sets the worksheet LowerBound
property at index.
Method SetMeshElementTypeValue(int, Sets the worksheet Mesh Element Type
MeshElementShape) (p. 838) Value property at index.
Method SetOperator(int, Sets the worksheet Operator property
NamedSelectionWorksheetOperator) (p. 838) at index.
Method SetStringValue(int, string) (p. 839) Sets the worksheet StringValue
property at index.
Method SetTag(uint, string) (p. 839) Sets the worksheet Tag property at
index.
Method SetUpperBound(int, double) (p. 839) Sets the worksheet UpperBound
property at index.
Method SetValue(int, double) (p. 840) Sets the worksheet Value property at
index.

RowCount
No details are provided for this entry.

Declaration Syntax
public int RowCount { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 829
Ansys.ACT.Automation.Mechanical Namespace

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()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
830 of ANSYS, Inc. and its subsidiaries and affiliates.
 SelectionWorksheet

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)

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 831
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
832 of ANSYS, Inc. and its subsidiaries and affiliates.
 SelectionWorksheet

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)

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)

Release 2022 R2 - © 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
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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
834 of ANSYS, Inc. and its subsidiaries and affiliates.
 SelectionWorksheet

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 835
Ansys.ACT.Automation.Mechanical Namespace

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
836 of ANSYS, Inc. and its subsidiaries and affiliates.
 SelectionWorksheet

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 837
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
838 of ANSYS, Inc. and its subsidiaries and affiliates.
 SelectionWorksheet

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 839
Ansys.ACT.Automation.Mechanical Namespace

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 255: Members

Property AlignWithFaceNormal (p. 841) Gets or sets the AlignWithFaceNormal.

Property BottomFaceNodes (p. 841) Gets or sets the BottomFaceNodes.
Property Children (p. 418) Gets the list of children.

(Inherited from GenericCrack (p. 417).)

Property CircumferentialDivisions (p. 842) Gets or sets the CircumferentialDivisions.
Property Comments (p. 418) Gets the list of associated comments.

(Inherited from GenericCrack (p. 417).)

Property Contact1Nodes (p. 842)
Property ContactPairsNodes (p. 842)
Property CoordinateSystem (p. 842)
Property CrackFacesNodes (p. 842)
Property CrackFrontDivisions (p. 842)
Property CrackFrontNodes (p. 843)
Gets or sets the Contact1Nodes.
Gets or sets the ContactPairsNodes.
Gets or sets the CoordinateSystem.
Gets or sets the CrackFacesNodes.
Gets or sets the CrackFrontDivisions.
Gets or sets the CrackFrontNodes.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
840 of ANSYS, Inc. and its subsidiaries and affiliates.
 SemiEllipticalCrack

Property CrackMeshMethod (p. 843) Gets or sets the CrackMeshMethod.

Property CrackShape (p. 843) Gets the CrackShape.
Property CrackSourceType (p. 843) Gets the CrackSourceType.
Property DataModelObjectCategory (p. 843) Gets the current DataModelObject's
category.
Property Figures (p. 418) Gets the list of associated figures.

(Inherited from GenericCrack (p. 417).)

Property FractureAffectedZone (p. 843) Gets or sets the FractureAffectedZone.
Property FractureAffectedZoneHeight (p. 844) Gets or sets the FractureAffectedZoneHeight.
Property FrontElementSize (p. 844) Gets or sets the FrontElementSize.
Property GrowthRate (p. 844) Gets or sets the GrowthRate.
Property Images (p. 418) Gets the list of associated images.

(Inherited from GenericCrack (p. 417).)

Property InternalObject (p. 844) Gets the internal object. For advanced usage
only.
Property LargestContourRadius (p. 844) Gets or sets the LargestContourRadius.
Property Location (p. 844) Gets or sets the Location.
Property MajorRadius (p. 845) Gets or sets the MajorRadius.
Property MeshContours (p. 845) Gets or sets the MeshContours.
Property MinorRadius (p. 845) Gets or sets the MinorRadius.
Property ProjectToNearestSurface (p. 845) Gets or sets the ProjectToNearestSurface.
Property SolutionContours (p. 845) Gets or sets the SolutionContours.
Property Suppressed (p. 845) Gets or sets the Suppressed.
Property Target1Nodes (p. 846) Gets or sets the Target1Nodes.
Property TopFaceNodes (p. 846) Gets or sets the TopFaceNodes.
Property XScaleFactor (p. 846) Gets or sets the XScaleFactor.
Property YScaleFactor (p. 846) Gets or sets the YScaleFactor.
Property ZScaleFactor (p. 846) Gets or sets the ZScaleFactor.

AlignWithFaceNormal
Gets or sets the AlignWithFaceNormal.

Declaration Syntax
public bool AlignWithFaceNormal { set;get; }

BottomFaceNodes
Gets or sets the BottomFaceNodes.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 841
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; }

CrackFrontDivisions
Gets or sets the CrackFrontDivisions.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
842 of ANSYS, Inc. and its subsidiaries and affiliates.
 SemiEllipticalCrack

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; }

FractureAffectedZone
Gets or sets the FractureAffectedZone.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 843
Ansys.ACT.Automation.Mechanical Namespace

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; }

Location
Gets or sets the Location.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
844 of ANSYS, Inc. and its subsidiaries and affiliates.
 SemiEllipticalCrack

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 845
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public double ZScaleFactor { set;get; }

SMARTCrackGrowth
Defines a SMARTCrackGrowth.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
846 of ANSYS, Inc. and its subsidiaries and affiliates.
 SMARTCrackGrowth

Declaration Syntax
public class SMARTCrackGrowth : GenericDelamination

Table 256: Members

Property Analysis (p. 848) Gets the Analysis.

Property AutomaticTimeStepping (p. 848) Gets or sets the AutomaticTimeStepping.
Property Children (p. 421) Gets the list of children.

(Inherited from GenericDelamination (p. 421).)

Property Comments (p. 422) Gets the list of associated comments.

(Inherited from GenericDelamination (p. 421).)

Property CrackGrowthLaw (p. 848)
Property CrackGrowthMethodology (p. 848)
Property CrackGrowthOption (p. 848)
Property CriticalRate (p. 849)
Property DataModelObjectCategory (p. 849)
Property FailureCriteriaOption (p. 849)
Property Figures (p. 422)
Gets the CrackGrowthLaw.
Gets or sets the CrackGrowthMethodology.
Gets or sets the CrackGrowthOption.
Gets or sets the CriticalRate.
Gets the current DataModelObject's
category.
Gets or sets the FailureCriteriaOption.
Gets the list of associated figures.

(Inherited from GenericDelamination (p. 421).)

Property Images (p. 422) Gets the list of associated images.

(Inherited from GenericDelamination (p. 421).)

Property InitialCrack (p. 849) Gets or sets the InitialCrack.
Property InitialTimeStep (p. 849) Gets or sets the InitialTimeStep.
Property InternalObject (p. 849) Gets the internal object. For advanced usage
only.
Property Material (p. 850) Gets or sets the Material.
Property MaximumTimeStep (p. 850) Gets or sets the MaximumTimeStep.
Property MaxIncrementOfCrackExtension (p. 850) Gets or sets the
MaxIncrementOfCrackExtension.
Property MaxIncrementValue (p. 850) Gets or sets the MaxIncrementValue.
Property Method (p. 850) Gets the Method.
Property MinimumTimeStep (p. 850) Gets or sets the MinimumTimeStep.
Property MinIncrementOfCrackExtension (p. 851) Gets or sets the
MinIncrementOfCrackExtension.
Property MinIncrementValue (p. 851) Gets or sets the MinIncrementValue.
Property NumberOfCycles (p. 851) Gets or sets the NumberOfCycles.
Property StopAtMaxCrackExtension (p. 851) Gets or sets the StopAtMaxCrackExtension.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 847
Ansys.ACT.Automation.Mechanical Namespace

Property StopAtMaxCrackExtensionValue (p. 851) Gets or sets the

StopAtMaxCrackExtensionValue.
Property StressRatio (p. 851) Gets or sets the StressRatio.
Property Suppressed (p. 852) 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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
848 of ANSYS, Inc. and its subsidiaries and affiliates.
 SMARTCrackGrowth

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 849
Ansys.ACT.Automation.Mechanical Namespace

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; }

Method
Gets the Method.

Declaration Syntax
public DelaminationMethod Method { get; }

MinimumTimeStep
Gets or sets the MinimumTimeStep.

Declaration Syntax
public Quantity MinimumTimeStep { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
850 of ANSYS, Inc. and its subsidiaries and affiliates.
 SMARTCrackGrowth

MinIncrementOfCrackExtension
Gets or sets the MinIncrementOfCrackExtension.

Declaration Syntax
public CrackGrowthIncrementType MinIncrementOfCrackExtension { set;get; }

MinIncrementValue
Gets or sets the MinIncrementValue.

Declaration Syntax
public Quantity MinIncrementValue { set;get; }

NumberOfCycles
Gets or sets the NumberOfCycles.

Declaration Syntax
public int NumberOfCycles { set;get; }

StopAtMaxCrackExtension
Gets or sets the StopAtMaxCrackExtension.

Declaration Syntax
public StopAtMaxCrackExtensionType StopAtMaxCrackExtension { set;get; }

StopAtMaxCrackExtensionValue
Gets or sets the StopAtMaxCrackExtensionValue.

Declaration Syntax
public Quantity StopAtMaxCrackExtensionValue { set;get; }

StressRatio
Gets or sets the StressRatio.

Declaration Syntax
public double StressRatio { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 851
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 257: Members

Property Children (p. 853) Gets the list of children.

Property Comments (p. 853) Gets the list of associated comments.
Property CoordinateSystem (p. 853) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 853) Gets the current DataModelObject's
category.
Property InternalObject (p. 853) Gets the internal object. For advanced usage
only.
Property PartName (p. 853) Gets the PartName.
Property X1 (p. 854) Gets or sets the X1.
Property X2 (p. 854) Gets or sets the X2.
Property Y1 (p. 854) Gets or sets the Y1.
Property Y2 (p. 854) Gets or sets the Y2.
Property Z1 (p. 854) Gets or sets the Z1.
Property Z2 (p. 854) Gets or sets the Z2.
Method AddComment() (p. 855) Creates a new child Comment.
Method AddGeometry() (p. 855) Add solid to the geometry.
Method Delete() (p. 855) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 855)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 855)
Method RemoveGeometry() (p. 856) Remove the solid from the geometry.
Method UpdateGeometry() (p. 856) Update the solid on the geometry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
852 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 853
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
854 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 2022 R2 - © 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 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, IFolderDataModelObject

Table 258: Members

Property AllThreadsCPUTime (p. 867) No details are provided for this e

Property CalculateBeamSectionResults (p. 867) Gets or sets the CalculateBeamSe
Property CellId (p. 867) Gets the CellId.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
856 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Property Children (p. 868) Gets the list of children.

Property Comments (p. 868) Gets the list of associated comm
Property CyclicSectorDisplayRangeBegin (p. 868) Gets or sets the
CyclicSectorDisplayRangeBegin.
Property DataModelObjectCategory (p. 868) Gets the current DataModelObje
Property DateOfRun (p. 868) No details are provided for this e
Property EigenSolverType (p. 868) No details are provided for this e
Property ElapsedRunTime (p. 869) Gets or sets the ElapsedRunTime
Property ElapsedTime (p. 869) No details are provided for this e
Property ElementLoadBalRatio (p. 869) No details are provided for this e
Property Elements (p. 869) No details are provided for this e
Property ElementSelection (p. 869) Gets or sets the ElementSelectio
Property EquationSolverType (p. 869) No details are provided for this e
Property ExportTopologyFile (p. 870) Gets or sets the ExportTopologyF
Property Figures (p. 870) Gets the list of associated figures
Property GpuAcceleration (p. 870) No details are provided for this e
Property GPUType (p. 870) No details are provided for this e
Property Images (p. 870) Gets the list of associated image
Property InternalObject (p. 870) Gets the internal object. For adva
only.
Property IOBound (p. 871) No details are provided for this e
Property IORead (p. 871) No details are provided for this e
Property IOWrite (p. 871) No details are provided for this e
Property IsDataExtractionComplete (p. 871) No details are provided for this e
Property IsDistributedSolution (p. 871) No details are provided for this e
Property IsEigenSolver (p. 871) No details are provided for this e
Property IsGPUAccelerationRequested (p. 872) No details are provided for this e
Property IsHybridParallelSolution (p. 872) No details are provided for this e
Property IsUnsymmetricMatrixSolve (p. 872) No details are provided for this e
Property License (p. 872) No details are provided for this e
Property LicenseCoresAvailable (p. 872) No details are provided for this e
Property MainThreadCPUTime (p. 872) No details are provided for this e
Property MaximumRefinementLoops (p. 873) Gets or sets the MaximumRefine
Property MemoryAvailable (p. 873) No details are provided for this e
Property MemoryUsed (p. 873) Gets or sets the MemoryUsed.
Property MeshSource (p. 873) Gets or sets the MeshSource.
Property MPIType (p. 873) No details are provided for this e
Property MSUPHarmonicAnalysis (p. 873) No details are provided for this e
Property Nodes (p. 874) No details are provided for this e

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 857
Ansys.ACT.Automation.Mechanical Namespace

Property NumberOfDOF (p. 874) Get the Number of DOF.

Property NumberOfProcessesRequested (p. 874) No details are provided for this e
Property NumberofSectors (p. 874) Gets or sets the NumberofSector
Property NumCoresAvailable (p. 874) No details are provided for this e
Property NumGPURequested (p. 874) No details are provided for this e
Property NumMachinesRequested (p. 875) No details are provided for this e
Property NumProcRequested (p. 875) No details are provided for this e
Property NumVirtualCoresAvailable (p. 875) No details are provided for this e
Property OperatingSystem (p. 875) No details are provided for this e
Property ProcessorModel (p. 875) No details are provided for this e
Property RefinementDepth (p. 875) Gets or sets the RefinementDept
Property ResultFileDirectory (p. 876) Gets the ResultFileDirectory.
Property ResultFileName (p. 876) Gets the ResultFileName.
Property ResultFilePath (p. 876) Get the result file full path.
Property ResultFileSize (p. 876) Gets the ResultFileSize.
Property ResultFileTimestamp (p. 876) Gets the ResultFileTimestamp.
Property ResultFileUnitSystem (p. 876) Gets the ResultFileUnitSystem.
Property ResultTrackingVectorLength (p. 877) No details are provided for this e
Property SolutionInformation (p. 877) Gets the SolutionInformation.
Property SolutionTrackingVectorLength (p. 877) No details are provided for this e
Property SolutionUnitSystem (p. 877) No details are provided for this e
Property SolverData (p. 877) No details are provided for this e
Property SolverType (p. 877) No details are provided for this e
Property SparseMode (p. 878) Get the Sparse Mode value.
Property Status (p. 878) Gets the Status.
Property ThreadsPerProcessRequested (p. 878) No details are provided for this e
Property TimeOfRun (p. 878) No details are provided for this e
Property TimeToCombineDistributedFiles (p. 878) No details are provided for this e
Property TopologyResult (p. 878) Gets or sets the TopologyResult.
Property TotalMemoryUsed (p. 879) No details are provided for this e
Property WorkingDir (p. 879) Gets the WorkingDir.
Method AddAccelerationFrequencyResponse() (p. 879) Creates a new
AccelerationFrequencyResponse
Method AddAccelerationPhaseResponse() (p. 879) Creates a new AccelerationPhase
Method AddAccelerationProbe() (p. 879) Creates a new AccelerationProbe
Method AddAccumulatedEquivalentPlasticStrain() (p. 879) Creates a new
AccumulatedEquivalentPlasticStr
Method AddAcousticAbsorptionCoefficient() (p. 880) Creates a new AcousticAbsorptio

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
858 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Method AddAcousticAWeightedSoundPressureLevel() (p. 880) Creates a new

AcousticAWeightedSoundPressur
Method AddAcousticAWeightedSPLFrequencyResponse() (p. 880) Creates a new
AcousticAWeightedSPLFrequency
Method AddAcousticDiffuseSoundTransmissionLoss() (p. 880) Creates a new
AcousticDiffuseSoundTransmissio
Method AddAcousticDirectionalVelocityResult() (p. 880) Creates a new
AcousticDirectionalVelocityResul
Method AddAcousticFarFieldAWeightedSPL() (p. 880) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldAWeightedSPLMic() (p. 881) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldDirectivity() (p. 881) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldMaximumPressure() (p. 881) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldMaximumPressureMic() (p. 881) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldMaximumScatteredPressure() (p. 881) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldPhase() (p. 881) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldPhaseMic() (p. 882) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSoundPowerLevel() (p. 882) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSoundPowerLevelWaterfallDiagram() (p. 882) Creates a new
AcousticFarFieldSoundPowerLeve
Method AddAcousticFarFieldSPL() (p. 882) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSPLMic() (p. 882) Creates a new AcousticFarFieldRe
Method AddAcousticFarFieldSPLMicWaterfallDiagram() (p. 882) Creates a new
AcousticFarFieldSPLMicWaterfallD
Method AddAcousticFarFieldTargetStrength() (p. 883) Creates a new AcousticFarFieldRe
Method AddAcousticFrequencyBandAWeightedSPL() (p. 883) Creates a new
AcousticFrequencyBandAWeighte
Method AddAcousticFrequencyBandSPL() (p. 883) Creates a new AcousticFrequenc
Method AddAcousticKineticEnergy() (p. 883) Creates a new AcousticKineticEn
Method AddAcousticKineticEnergyFrequencyResponse() (p. 883) Creates a new
AcousticKineticEnergyFrequency
Method AddAcousticPotentialEnergy() (p. 883) Creates a new AcousticPotentialE
Method AddAcousticPotentialEnergyFrequencyResponse() (p. 884) Creates a new
AcousticPotentialEnergyFrequenc
Method AddAcousticPressureFrequencyResponse() (p. 884) Creates a new
AcousticPressureFrequencyRespo
Method AddAcousticPressureResult() (p. 884) Creates a new AcousticPressureR
Method AddAcousticReturnLoss() (p. 884) Creates a new AcousticReturnLos
Method AddAcousticSoundPressureLevel() (p. 884) Creates a new AcousticSoundPre
Method AddAcousticSPLFrequencyResponse() (p. 884) Creates a new
AcousticSPLFrequencyResponse
Method AddAcousticTotalVelocityResult() (p. 885) Creates a new AcousticTotalVelo

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 859
Ansys.ACT.Automation.Mechanical Namespace

Method AddAcousticTransmissionLoss() (p. 885) Creates a new AcousticTransmiss

Method AddAcousticVelocityFrequencyResponse() (p. 885) Creates a new
AcousticVelocityFrequencyRespo
Method AddAngularAccelerationProbe() (p. 885) Creates a new AngularAccelerati
Method AddAngularVelocityProbe() (p. 885) Creates a new AngularVelocityPr
Method AddBeamProbe() (p. 885) Creates a new BeamProbe
Method AddBeamTool() (p. 886) Creates a new BeamTool
Method AddBearingProbe() (p. 886) Creates a new BearingProbe
Method AddBendingStressEquivalent() (p. 886) Creates a new BendingStressEqu
Method AddBendingStressIntensity() (p. 886) Creates a new BendingStressInte
Method AddBoltPretensionProbe() (p. 886) Creates a new BoltPretensionPro
Method AddBoltTool() (p. 886) Creates a new BoltTool
Method AddCampbellDiagram() (p. 887) Creates a new CampbellDiagram
Method AddChargeReactionFrequencyResponse() (p. 887) Creates a new
ChargeReactionFrequencyRespon
Method AddChargeReactionProbe() (p. 887) Creates a new ChargeReactionPr
Method AddCommandSnippet() (p. 887) Creates a new CommandSnippet
Method AddComment() (p. 887) Creates a new child Comment.
Method AddCompositeCriterion() (p. 887) Creates a new CompositeCriterio
Method AddCompositeFailureTool() (p. 888) Creates a new CompositeFailureT
Method AddCompositeSamplingPointTool() (p. 888) Creates a new CompositeSamplin
Method AddContactTool() (p. 888) Creates a new ContactTool
Method AddCurrentDensity() (p. 888) Creates a new CurrentDensity
Method AddCurrentDensityProbe() (p. 888) Creates a new CurrentDensityPro
Method AddDamageStatus() (p. 888) Creates a new DamageStatus
Method AddDeformationFrequencyResponse() (p. 889) Creates a new
DeformationFrequencyResponse
Method AddDeformationPhaseResponse() (p. 889) Creates a new DeformationPhase
Method AddDeformationProbe() (p. 889) Creates a new DeformationProbe
Method AddDirectionalAcceleration() (p. 889) Creates a new DirectionalAcceler
Method AddDirectionalAccelerationPSD() (p. 889) Creates a new DirectionalAcceler
Method AddDirectionalAccelerationRS() (p. 889) Creates a new DirectionalAcceler
Method AddDirectionalAxialForce() (p. 890) Creates a new DirectionalAxialFo
Method AddDirectionalBendingMoment() (p. 890) Creates a new DirectionalBendin
Method AddDirectionalCurrentDensity() (p. 890) Creates a new DirectionalCurren
Method AddDirectionalDeformation() (p. 890) Creates a new DirectionalDeform
Method AddDirectionalElectricFieldIntensity() (p. 890) Creates a new DirectionalElectric
Method AddDirectionalElectricFluxDensity() (p. 890) Creates a new DirectionalElectric
Method AddDirectionalHeatFlux() (p. 891) Creates a new DirectionalHeatFlu

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
860 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Method AddDirectionalMagneticFieldIntensity() (p. 891) Creates a new

DirectionalMagneticFieldIntensit
Method AddDirectionalMagneticFluxDensity() (p. 891) Creates a new DirectionalMagne
Method AddDirectionalShearForce() (p. 891) Creates a new DirectionalShearF
Method AddDirectionalTorsionalMoment() (p. 891) Creates a new DirectionalTorsion
Method AddDirectionalVelocity() (p. 891) Creates a new DirectionalVelocit
Method AddDirectionalVelocityPSD() (p. 892) Creates a new DirectionalVelocit
Method AddDirectionalVelocityRS() (p. 892) Creates a new DirectionalVelocit
Method AddElasticStrainFrequencyResponse() (p. 892) Creates a new ElasticStrainFrequ
Method AddElasticStrainIntensity() (p. 892) Creates a new ElasticStrainIntens
Method AddElasticStrainPhaseResponse() (p. 892) Creates a new ElasticStrainPhase
Method AddElectricFieldProbe() (p. 892) Creates a new ElectricFieldProbe
Method AddElectricPotential() (p. 893) Creates a new ElectricPotential
Method AddElectricVoltage() (p. 893) Creates a new ElectricVoltage
Method AddElectromechanicalCouplingCoefficient() (p. 893) Creates a new
ElectromechanicalCouplingCoeff
Method AddElementalEulerXYAngle() (p. 893) Creates a new ElementalEulerXYA
Method AddElementalEulerXZAngle() (p. 893) Creates a new ElementalEulerXZ
Method AddElementalEulerYZAngle() (p. 893) Creates a new ElementalEulerYZA
Method AddElementalStrainEnergy() (p. 894) Creates a new ElementalStrainEn
Method AddElementalTriads() (p. 894) Creates a new ElementalTriads
Method AddEmagReactionProbe() (p. 894) Creates a new EmagReactionPro
Method AddEnergyDissipatedPerUnitVolume() (p. 894) Creates a new
EnergyDissipatedPerUnitVolume
Method AddEnergyProbe() (p. 894) Creates a new EnergyProbe
Method AddEquivalentCreepStrain() (p. 894) Creates a new EquivalentCreepSt
Method AddEquivalentCreepStrainRST() (p. 895) Creates a new EquivalentCreepSt
Method AddEquivalentElasticStrain() (p. 895) Creates a new EquivalentElasticS
Method AddEquivalentElasticStrainRST() (p. 895) Creates a new EquivalentElasticS
Method AddEquivalentPlasticStrain() (p. 895) Creates a new EquivalentPlasticS
Method AddEquivalentPlasticStrainRST() (p. 895) Creates a new EquivalentPlasticS
Method AddEquivalentRadiatedPower() (p. 895) Creates a new EquivalentRadiate
Method AddEquivalentRadiatedPowerLevel() (p. 896) Creates a new EquivalentRadiate
Method AddEquivalentRadiatedPowerLevelWaterfallDiagram() (p. 896) Creates a new
EquivalentRadiatedPowerLevelW
Method AddEquivalentRadiatedPowerWaterfallDiagram() (p. 896) Creates a new
EquivalentRadiatedPowerWaterfa
Method AddEquivalentStress() (p. 896) Creates a new EquivalentStress
Method AddEquivalentStressPSD() (p. 896) Creates a new EquivalentStressPS
Method AddEquivalentStressRS() (p. 897) Creates a new EquivalentStressR

Release 2022 R2 - © 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 AddEquivalentTotalStrain() (p. 897) Creates a new EquivalentTotalStr

Method AddExpansionSettings() (p. 897) Creates a new ExpansionSettings
Method AddFatigueTool() (p. 897) No details are provided for this e
Method AddFiberCompressiveDamageVariable() (p. 897) Creates a new
FiberCompressiveDamageVariabl
Method AddFiberCompressiveFailureCriterion() (p. 897) Creates a new
FiberCompressiveFailureCriterion
Method AddFiberTensileDamageVariable() (p. 898) Creates a new FiberTensileDama
Method AddFiberTensileFailureCriterion() (p. 898) Creates a new FiberTensileFailure
Method AddFieldIntensityProbe() (p. 898) Creates a new FieldIntensityProb
Method AddFigure() (p. 898) Creates a new child Figure.
Method AddFlexibleRotationProbe() (p. 898) Creates a new FlexibleRotationPr
Method AddFluidFlowRate() (p. 898) Creates a new FluidFlowRate
Method AddFluidHeatConductionRate() (p. 899) Creates a new FluidHeatConduct
Method AddFluidHeatTransportRate() (p. 899) Creates a new FluidHeatTranspor
Method AddFluxDensityProbe() (p. 899) Creates a new FluxDensityProbe
Method AddFluxLinkage() (p. 899) Creates a new FluxLinkage
Method AddForceReaction() (p. 899) Creates a new ForceReaction
Method AddForceReactionFrequencyResponse() (p. 899) Creates a new
ForceReactionFrequencyRespons
Method AddForceReactionsForContactRegions(IEnumerable<int>) (p. 900) Bulk creates Force Reactions for
Regions by Contact object Ids
Method AddForceSummationProbe() (p. 900) Creates a new ForceSummationP
Method AddFractureTool() (p. 900) Creates a new FractureTool
Method AddGeneralizedPlaneStrainProbe() (p. 900) Creates a new GeneralizedPlaneS
Method AddGroupedScopedACPResults(ResultType, No details are provided for this e
IEnumerable<IDataModelObject>) (p. 900)
Method AddGroupedScopedCustomResult(IEnumerable<IDataModelObject>) (p. 901) No details are provided for this e
Method AddHeatFluxProbe() (p. 901) Creates a new HeatFluxProbe
Method AddImage(string) (p. 901) 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. 901) Creates a new ImpedanceFreque
Method AddImpedanceProbe() (p. 902) Creates a new ImpedanceProbe
Method AddInductance() (p. 902) Creates a new Inductance
Method AddJointProbe() (p. 902) Creates a new JointProbe
Method AddJouleHeat() (p. 902) Creates a new JouleHeat
Method AddJouleHeatProbe() (p. 902) Creates a new JouleHeatProbe
Method AddLatticeDensity() (p. 902) Creates a new LatticeDensity
Method AddLatticeElementalDensity() (p. 903) Creates a new LatticeElementalD

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
862 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Method AddLinearizedEquivalentStress() (p. 903) Creates a new LinearizedEquivale

Method AddLinearizedMaximumPrincipalStress() (p. 903) Creates a new
LinearizedMaximumPrincipalStre
Method AddLinearizedMaximumShearStress() (p. 903) Creates a new LinearizedMaximu
Method AddLinearizedMiddlePrincipalStress() (p. 903) Creates a new LinearizedMiddleP
Method AddLinearizedMinimumPrincipalStress() (p. 903) Creates a new
LinearizedMinimumPrincipalStres
Method AddLinearizedNormalStress() (p. 904) Creates a new LinearizedNormal
Method AddLinearizedShearStress() (p. 904) Creates a new LinearizedShearSt
Method AddLinearizedStressIntensity() (p. 904) Creates a new LinearizedStressIn
Method AddLinePressureResult() (p. 904) Creates a new LinePressureResul
Method AddMagneticCoenergy() (p. 904) Creates a new MagneticCoenerg
Method AddMagneticDirectionalForces() (p. 904) Creates a new MagneticDirection
Method AddMagneticError() (p. 905) Creates a new MagneticError
Method AddMagneticFluxProbe() (p. 905) Creates a new MagneticFluxProb
Method AddMagneticPotential() (p. 905) Creates a new MagneticPotentia
Method AddMagneticTotalForces() (p. 905) Creates a new MagneticTotalForc
Method AddMatrixCompressiveDamageVariable() (p. 905) Creates a new
MatrixCompressiveDamageVariab
Method AddMatrixCompressiveFailureCriterion() (p. 905) Creates a new
MatrixCompressiveFailureCriterio
Method AddMatrixTensileDamageVariable() (p. 906) Creates a new MatrixTensileDam
Method AddMatrixTensileFailureCriterion() (p. 906) Creates a new MatrixTensileFailu
Method AddMaximumFailureCriteria() (p. 906) Creates a new MaximumFailureC
Method AddMaximumPrincipalElasticStrain() (p. 906) Creates a new MaximumPrincipa
Method AddMaximumPrincipalStress() (p. 906) Creates a new MaximumPrincipa
Method AddMaximumPrincipalThermalStrain() (p. 906) Creates a new
MaximumPrincipalThermalStrain
Method AddMaximumShearElasticStrain() (p. 907) Creates a new MaximumShearEla
Method AddMaximumShearStress() (p. 907) Creates a new MaximumShearStr
Method AddMembraneStressEquivalent() (p. 907) Creates a new MembraneStressE
Method AddMembraneStressIntensity() (p. 907) Creates a new MembraneStressIn
Method AddMiddlePrincipalElasticStrain() (p. 907) Creates a new MiddlePrincipalEla
Method AddMiddlePrincipalStress() (p. 907) Creates a new MiddlePrincipalStr
Method AddMiddlePrincipalThermalStrain() (p. 908) Creates a new MiddlePrincipalTh
Method AddMinimumPrincipalElasticStrain() (p. 908) Creates a new MinimumPrincipa
Method AddMinimumPrincipalStress() (p. 908) Creates a new MinimumPrincipa
Method AddMomentReaction() (p. 908) Creates a new MomentReaction
Method AddMomentReactionsForContactRegions(IEnumerable<int>) (p. 908) Bulk creates Moment Reactions f
Regions by Contact object Ids

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 863
Ansys.ACT.Automation.Mechanical Namespace

Method AddMullinsDamageVariable() (p. 909) Creates a new MullinsDamageVa

Method AddMullinsMaximumPreviousStrainEnergy() (p. 909) Creates a new
MullinsMaximumPreviousStrainE
Method AddNewtonRaphsonResidualCharge() (p. 909) Creates a new
NewtonRaphsonResidualCharge
Method AddNewtonRaphsonResidualForce() (p. 909) Creates a new NewtonRaphsonR
Method AddNewtonRaphsonResidualHeat() (p. 909) Creates a new NewtonRaphsonR
Method AddNewtonRaphsonResidualMoment() (p. 910) Creates a new
NewtonRaphsonResidualMomen
Method AddNodalEulerXYAngle() (p. 910) Creates a new NodalEulerXYAngl
Method AddNodalEulerXZAngle() (p. 910) Creates a new NodalEulerXZAng
Method AddNodalEulerYZAngle() (p. 910) Creates a new NodalEulerYZAng
Method AddNodalTriads() (p. 910) Creates a new NodalTriads
Method AddNormalElasticStrain() (p. 910) Creates a new NormalElasticStrai
Method AddNormalGasketPressure() (p. 911) Creates a new NormalGasketPres
Method AddNormalGasketTotalClosure() (p. 911) Creates a new NormalGasketTota
Method AddNormalStress() (p. 911) Creates a new NormalStress
Method AddPosition() (p. 911) Creates a new Position
Method AddPrimaryCriterion() (p. 911) Creates a new PrimaryCriterion
Method AddPythonCodeEventBased() (p. 911) Creates a new PythonCodeEvent
Method AddPythonResult() (p. 912) Creates a new PythonResult
Method AddQualityFactor() (p. 912) Creates a new QualityFactor
Method AddRadiationProbe() (p. 912) Creates a new RadiationProbe
Method AddReactionProbe() (p. 912) Creates a new ReactionProbe
Method AddReactionsForContactRegions(IEnumerable<int>) (p. 912) Bulk creates Reactions for Contac
by Contact object Ids
Method AddResponsePSD() (p. 913) Creates a new ResponsePSD
Method AddResponsePSDTool() (p. 913) Creates a new ResponsePSDTool
Method AddResultMesh() (p. 913) Creates a new ResultMesh
Method AddRotationProbe() (p. 913) Creates a new RotationProbe
Method AddShapeFinder() (p. 913) Creates a new ShapeFinder
Method AddShapeFinderElemental() (p. 913) Creates a new ShapeFinderEleme
Method AddShearDamageVariable() (p. 914) Creates a new ShearDamageVari
Method AddShearElasticStrain() (p. 914) Creates a new ShearElasticStrain
Method AddShearGasketPressure() (p. 914) Creates a new ShearGasketPressu
Method AddShearGasketTotalClosure() (p. 914) Creates a new ShearGasketTotalC
Method AddShearMomentDiagramMSUM() (p. 914) Creates a new TotalShearMomen
Method AddShearMomentDiagramMY() (p. 914) Creates a new
DirectionalShearMomentDiagram

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
864 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Method AddShearMomentDiagramMZ() (p. 915) Creates a new

DirectionalShearMomentDiagram
Method AddShearMomentDiagramUSUM() (p. 915) Creates a new TotalShearMomen
Method AddShearMomentDiagramUY() (p. 915) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUZ() (p. 915) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVSUM() (p. 915) Creates a new TotalShearMomen
Method AddShearMomentDiagramVY() (p. 915) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVZ() (p. 916) Creates a new
DirectionalShearMomentDiagram
Method AddShearStress() (p. 916) Creates a new ShearStress
Method AddShellBendingStress() (p. 916) Creates a new ShellBendingStres
Method AddShellBottomPeakStress() (p. 916) Creates a new ShellBottomPeakS
Method AddShellMembraneStress() (p. 916) Creates a new ShellMembraneSt
Method AddShellTopPeakStress() (p. 916) Creates a new ShellTopPeakStres
Method AddSpringProbe() (p. 917) Creates a new SpringProbe
Method AddStabilizationEnergy() (p. 917) Creates a new StabilizationEnerg
Method AddStrainProbe() (p. 917) Creates a new StrainProbe
Method AddStressFrequencyResponse() (p. 917) Creates a new StressFrequencyRe
Method AddStressIntensity() (p. 917) Creates a new StressIntensity
Method AddStressPhaseResponse() (p. 917) Creates a new StressPhaseRespo
Method AddStressProbe() (p. 918) Creates a new StressProbe
Method AddStressTool() (p. 918) Creates a new StressTool
Method AddStructuralError() (p. 918) Creates a new StructuralError
Method AddStructuralStrainEnergy() (p. 918) Creates a new StructuralStrainEn
Method AddTemperature() (p. 918) Creates a new TemperatureResul
Method AddTemperatureProbe() (p. 918) Creates a new TemperatureProbe
Method AddThermalError() (p. 919) Creates a new ThermalError
Method AddThermalStrain() (p. 919) Creates a new DirectionalTherma
Method AddThermalStrainEnergy() (p. 919) Creates a new ThermalStrainEner
Method AddTopologyDensity() (p. 919) Creates a new TopologyDensity
Method AddTopologyElementalDensity() (p. 919) Creates a new TopologyElementa
Method AddTorqueProbe() (p. 919) Creates a new TorqueProbe
Method AddTotalAcceleration() (p. 920) Creates a new TotalAcceleration
Method AddTotalAxialForce() (p. 920) Creates a new TotalAxialForce
Method AddTotalBendingMoment() (p. 920) Creates a new TotalBendingMom
Method AddTotalCurrentDensity() (p. 920) Creates a new TotalCurrentDensi
Method AddTotalDeformation() (p. 920) Creates a new TotalDeformation

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 865
Ansys.ACT.Automation.Mechanical Namespace

Method AddTotalElectricFieldIntensity() (p. 920) Creates a new TotalElectricFieldIn

Method AddTotalElectricFluxDensity() (p. 921) Creates a new TotalElectricFluxD
Method AddTotalHeatFlux() (p. 921) Creates a new TotalHeatFlux
Method AddTotalMagneticFieldIntensity() (p. 921) Creates a new TotalMagneticField
Method AddTotalMagneticFluxDensity() (p. 921) Creates a new TotalMagneticFlux
Method AddTotalShearForce() (p. 921) Creates a new TotalShearForce
Method AddTotalTorsionalMoment() (p. 921) Creates a new TotalTorsionalMom
Method AddTotalVelocity() (p. 922) Creates a new TotalVelocity
Method AddUserDefinedResult() (p. 922) Creates a new UserDefinedResul
Method AddVariableGraph() (p. 922) Creates a new VariableGraph
Method AddVectorAxialForce() (p. 922) Creates a new VectorAxialForce
Method AddVectorBendingMoment() (p. 922) Creates a new VectorBendingMo
Method AddVectorDeformation() (p. 922) Creates a new VectorDeformatio
Method AddVectorHeatFlux() (p. 923) Creates a new VectorHeatFlux
Method AddVectorPrincipalElasticStrain() (p. 923) Creates a new VectorPrincipalEla
Method AddVectorPrincipalStress() (p. 923) Creates a new VectorPrincipalStr
Method AddVectorShearForce() (p. 923) Creates a new VectorShearForce
Method AddVectorTorsionalMoment() (p. 923) Creates a new VectorTorsionalMo
Method AddVelocityFrequencyResponse() (p. 923) Creates a new VelocityFrequency
Method AddVelocityPhaseResponse() (p. 924) Creates a new VelocityPhaseResp
Method AddVelocityProbe() (p. 924) Creates a new VelocityProbe
Method AddVoltageFrequencyResponse() (p. 924) Creates a new VoltageFrequency
Method AddVoltageProbe() (p. 924) Creates a new ElectricVoltagePro
Method AddVolume() (p. 924) Creates a new Volume
Method AddVolumeProbe() (p. 924) Creates a new VolumeProbe
Method ClearGeneratedData() (p. 925) Run the ClearGeneratedData act
Method CreateResultsAtAllSets(uint) (p. 925) No details are provided for this e
Method DeleteRow(uint) (p. 925) No details are provided for this e
Method EvaluateAllContactTrackers() (p. 925) No details are provided for this e
Method EvaluateAllResults() (p. 925) Run the EvaluateAllResults action
Method EvaluateContactTracker() (p. 926) No details are provided for this e
Method ExecutePostCommands() (p. 926) Run Execute Post Commands for
command objects.
Method ExecutePostCommands(IEnumerable<IDataModelObject>) (p. 926) Run Execute Post Commands for
post commands objects.
Method ExportSubstructureInCPAFormat(string, bool) (p. 926) Export Substructure to cpa file.
Method ExtractSolutionStatistics() (p. 927) No details are provided for this e
Method FetchRemoteResults() (p. 927) No details are provided for this e
Method FormatValue(double, int) (p. 927) No details are provided for this e

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
866 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Method GenerateAdaptedMesh() (p. 927) No details are provided for this e

Method GetChildren<ChildrenType>(bool, IList<ChildrenType>) (p. 927) Gets the list of children, filtered b
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered b
IList<IDataModelObject>) (p. 928)
Method GetResults() (p. 928) Gets the Results from the server.
Method IsResultFileChanged() (p. 928) Checks if the referenced result fi
changed.
Method IsResultFileSameAsLoaded(string) (p. 929) Checks if the given result file is s
loaded result file
Method OpenSolverFilesDirectory() (p. 929) Run the OpenSolverFilesDirector
Method ReadAnsysResultFile() (p. 929) Run the Ansys ReadResults actio
Method ReadGivenAnsysResultFile(string, UnitSystemIDType) (p. 929) Run the given Ansys ReadResults
Method RelinkResultFile(string) (p. 930) Relink the result file. This action
repairing the result file referencin
altering the generated result dat
Method ReloadResultFile() (p. 930) Reload the result file. This action
result mesh data and resets all re
scopings.
Method Solve(bool, SolveConfiguration) (p. 930) Run the Solve action.
Method Solve(bool, string) (p. 930) Run the Solve action.
Method ValueForResultTracking(uint, string) (p. 931) No details are provided for this e
Method ValueForSolutionTracking(uint, string) (p. 931) No details are provided for this e

AllThreadsCPUTime
No details are provided for this entry.

Declaration Syntax
public double AllThreadsCPUTime { get; }

CalculateBeamSectionResults
Gets or sets the CalculateBeamSectionResults.

Declaration Syntax
public bool CalculateBeamSectionResults { set;get; }

CellId
Gets the CellId.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 867
Ansys.ACT.Automation.Mechanical Namespace

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; }

DateOfRun
No details are provided for this entry.

Declaration Syntax
public string DateOfRun { get; }

EigenSolverType
No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
868 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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; }

ElementSelection
Gets or sets the ElementSelection.

Declaration Syntax
public ConvergenceControlType ElementSelection { set;get; }

EquationSolverType
No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 869
Ansys.ACT.Automation.Mechanical Namespace

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; }

Images
Gets the list of associated images.

Declaration Syntax
public IEnumerable<Image> Images { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
870 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 871
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
872 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 873
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
874 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 875
Ansys.ACT.Automation.Mechanical Namespace

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; }

ResultFileSize
Gets the ResultFileSize.

Declaration Syntax
public double ResultFileSize { get; }

ResultFileTimestamp
Gets the ResultFileTimestamp.

Declaration Syntax
public string ResultFileTimestamp { get; }

ResultFileUnitSystem
Gets the ResultFileUnitSystem.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
876 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public WBUnitSystemType ResultFileUnitSystem { get; }

ResultTrackingVectorLength
No details are provided for this entry.

Declaration Syntax
public int ResultTrackingVectorLength { get; }

SolutionInformation
Gets the SolutionInformation.

Declaration Syntax
public SolutionInformation SolutionInformation { get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 877
Ansys.ACT.Automation.Mechanical Namespace

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
878 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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; }

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()

AddAccumulatedEquivalentPlasticStrain()
Creates a new AccumulatedEquivalentPlasticStrain

Release 2022 R2 - © 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 virtual AccumulatedEquivalentPlasticStrain AddAccumulatedEquivalentPlasticStrain()

AddAcousticAbsorptionCoefficient()
Creates a new AcousticAbsorptionCoefficient

Declaration Syntax
public virtual AcousticAbsorptionCoefficient AddAcousticAbsorptionCoefficient()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
880 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldAWeightedSPL()

AddAcousticFarFieldAWeightedSPLMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldAWeightedSPLMic()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 881
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldPhase()

AddAcousticFarFieldPhaseMic()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldPhaseMic()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
882 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public virtual AcousticFarFieldSPLMicWaterfallDiagram AddAcousticFarFieldSPLMicWaterfallDiagram()

AddAcousticFarFieldTargetStrength()
Creates a new AcousticFarFieldResult

Declaration Syntax
public virtual AcousticFarFieldResult AddAcousticFarFieldTargetStrength()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 883
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual AcousticPotentialEnergy AddAcousticPotentialEnergy()

AddAcousticPotentialEnergyFrequencyResponse()
Creates a new AcousticPotentialEnergyFrequencyResponse

Declaration Syntax
public virtual AcousticPotentialEnergyFrequencyResponse AddAcousticPotentialEnergyFrequencyRe-
sponse()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
884 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public virtual AcousticSPLFrequencyResponse AddAcousticSPLFrequencyResponse()

AddAcousticTotalVelocityResult()
Creates a new AcousticTotalVelocityResult

Declaration Syntax
public virtual AcousticTotalVelocityResult AddAcousticTotalVelocityResult()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 885
Ansys.ACT.Automation.Mechanical Namespace

Declaration Syntax
public virtual BeamProbe AddBeamProbe()

AddBeamTool()
Creates a new BeamTool

Declaration Syntax
public virtual BeamTool AddBeamTool()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
886 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public virtual BoltTool AddBoltTool()

AddCampbellDiagram()
Creates a new CampbellDiagram

Declaration Syntax
public virtual CampbellDiagram AddCampbellDiagram()

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

Release 2022 R2 - © 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 virtual CompositeCriterion AddCompositeCriterion()

AddCompositeFailureTool()
Creates a new CompositeFailureTool

Declaration Syntax
public virtual CompositeFailureTool AddCompositeFailureTool()

AddCompositeSamplingPointTool()
Creates a new CompositeSamplingPointTool

Declaration Syntax
public virtual CompositeSamplingPointTool AddCompositeSamplingPointTool()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
888 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public virtual DamageStatus AddDamageStatus()

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

Release 2022 R2 - © 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 virtual DirectionalAccelerationRS AddDirectionalAccelerationRS()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
890 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

Declaration Syntax
public virtual DirectionalElectricFluxDensity AddDirectionalElectricFluxDensity()

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()

AddDirectionalVelocity()
Creates a new DirectionalVelocity

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 891
Ansys.ACT.Automation.Mechanical Namespace

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()

AddElectricFieldProbe()
Creates a new ElectricFieldProbe

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
892 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

AddElementalEulerYZAngle()
Creates a new ElementalEulerYZAngle

Release 2022 R2 - © 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 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()

AddEquivalentCreepStrain()
Creates a new EquivalentCreepStrain

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
894 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

AddEquivalentRadiatedPower()
Creates a new EquivalentRadiatedPower

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 895
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual EquivalentStressPSD AddEquivalentStressPSD()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
896 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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

Declaration Syntax
public virtual FiberCompressiveFailureCriterion AddFiberCompressiveFailureCriterion()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 897
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual FluidFlowRate AddFluidFlowRate()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
898 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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

Declaration Syntax
public virtual ForceReactionFrequencyResponse AddForceReactionFrequencyResponse()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 899
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual void AddGroupedScopedACPResults(ResultType resultType, IEnumerable<IDataMode-
lObject> selectedPlies)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
900 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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)

Parameters
filePath(string)

Full path of file. Defaults to None.

AddImpedanceFrequencyResponse()
Creates a new ImpedanceFrequencyResponse

Release 2022 R2 - © 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 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()

AddJouleHeatProbe()
Creates a new JouleHeatProbe

Declaration Syntax
public virtual JouleHeatProbe AddJouleHeatProbe()

AddLatticeDensity()
Creates a new LatticeDensity

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
902 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

AddLinearizedMiddlePrincipalStress()
Creates a new LinearizedMiddlePrincipalStress

Declaration Syntax
public virtual LinearizedMiddlePrincipalStress AddLinearizedMiddlePrincipalStress()

AddLinearizedMinimumPrincipalStress()
Creates a new LinearizedMinimumPrincipalStress

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 903
Ansys.ACT.Automation.Mechanical Namespace

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()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
904 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 905
Ansys.ACT.Automation.Mechanical Namespace

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()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
906 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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

Release 2022 R2 - © 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 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()

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
908 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 909
Ansys.ACT.Automation.Mechanical Namespace

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
910 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 911
Ansys.ACT.Automation.Mechanical Namespace

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()

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
912 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 913
Ansys.ACT.Automation.Mechanical Namespace

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
914 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramVSUM()

AddShearMomentDiagramVY()
Creates a new DirectionalShearMomentDiagram

Declaration Syntax
public virtual DirectionalShearMomentDiagram AddShearMomentDiagramVY()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 915
Ansys.ACT.Automation.Mechanical Namespace

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
916 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 917
Ansys.ACT.Automation.Mechanical Namespace

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
918 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 919
Ansys.ACT.Automation.Mechanical Namespace

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
920 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

AddTotalElectricFluxDensity()
Creates a new TotalElectricFluxDensity

Declaration Syntax
public virtual TotalElectricFluxDensity AddTotalElectricFluxDensity()

AddTotalHeatFlux()
Creates a new TotalHeatFlux

Declaration Syntax
public virtual TotalHeatFlux AddTotalHeatFlux()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 921
Ansys.ACT.Automation.Mechanical Namespace

AddTotalVelocity()
Creates a new TotalVelocity

Declaration Syntax
public virtual TotalVelocity AddTotalVelocity()

AddUserDefinedResult()
Creates a new UserDefinedResult

Declaration Syntax
public virtual UserDefinedResult AddUserDefinedResult()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
922 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

AddVectorHeatFlux()
Creates a new VectorHeatFlux

Declaration Syntax
public virtual VectorHeatFlux AddVectorHeatFlux()

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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 923
Ansys.ACT.Automation.Mechanical Namespace

AddVelocityPhaseResponse()
Creates a new VelocityPhaseResponse

Declaration Syntax
public virtual VelocityPhaseResponse AddVelocityPhaseResponse()

AddVelocityProbe()
Creates a new VelocityProbe

Declaration Syntax
public virtual VelocityProbe AddVelocityProbe()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
924 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

ClearGeneratedData()
Run the ClearGeneratedData action.

Declaration Syntax
public virtual void ClearGeneratedData()

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.

EvaluateAllContactTrackers()
No details are provided for this entry.

Declaration Syntax
public virtual void EvaluateAllContactTrackers()

EvaluateAllResults()
Run the EvaluateAllResults action.

Release 2022 R2 - © 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 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.

ExportSubstructureInCPAFormat(string, bool)
Export Substructure to cpa file.

Declaration Syntax
public virtual void ExportSubstructureInCPAFormat(string exportFileName, bool bAddOnDemandEx-
pansionFiles)

Parameters
exportFileName(string)

File path for the cpa file to be exported

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
926 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

bAddOnDemandExpansionFiles(bool)

Bool decides whether to add on-demand expansion files to .cpa

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.

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.

Release 2022 R2 - © 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 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.)

GetResults()
Gets the Results from the server.

Declaration Syntax
public virtual void GetResults()

IsResultFileChanged()
Checks if the referenced result file has been changed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
928 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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.

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 929
Ansys.ACT.Automation.Mechanical Namespace

unitSystemID(UnitSystemIDType)

The unit system ID as defined in Ansys.Mechanical.DataModel.Enums.UnitSystemIDType

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. 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
930 of ANSYS, Inc. and its subsidiaries and affiliates.
 Solution

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. 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 931
Ansys.ACT.Automation.Mechanical Namespace

SolutionCombination
Defines a SolutionCombination.

Declaration Syntax
public class SolutionCombination : DataModelObject, IFolderDataModelObject

Table 259: Members

Property Children (p. 934) Gets the list of children.

Property Comments (p. 934) Gets the list of associated comments.
Property DataModelObjectCategory (p. 934) Gets the current DataModelObject's
category.
Property Definition (p. 935) Get the SolutionCombinationDefinition
object. This object contains all the Solution
Combination data like Base Cases, Load
Combinations and Coefficients.
Property Images (p. 935) Gets the list of associated images.
Property InternalObject (p. 935) Gets the internal object. For advanced
usage only.
Method AddBeamTool() (p. 935) Creates a new BeamTool
Method AddComment() (p. 935) Creates a new child Comment.
Method AddContactTool() (p. 935) Creates a new ContactTool
Method AddDirectionalAcceleration() (p. 936) Creates a new DirectionalAcceleration
Method AddDirectionalAxialForce() (p. 936) Creates a new DirectionalAxialForce
Method AddDirectionalBendingMoment() (p. 936) Creates a new DirectionalBendingMoment
Method AddDirectionalDeformation() (p. 936) Creates a new DirectionalDeformation
Method AddDirectionalShearForce() (p. 936) Creates a new DirectionalShearForce
Method AddDirectionalTorsionalMoment() (p. 936) Creates a new DirectionalTorsionalMoment
Method AddDirectionalVelocity() (p. 937) Creates a new DirectionalVelocity
Method AddElasticStrainIntensity() (p. 937) Creates a new ElasticStrainIntensity
Method AddEquivalentElasticStrain() (p. 937) Creates a new EquivalentElasticStrain
Method AddEquivalentElasticStrainRST() (p. 937) Creates a new EquivalentElasticStrainRST
Method AddEquivalentStress() (p. 937) Creates a new EquivalentStress
Method AddEquivalentTotalStrain() (p. 937) Creates a new EquivalentTotalStrain
Method AddFatigueTool() (p. 938) Creates a new FatigueTool
Method AddImage(string) (p. 938) 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 AddLinearizedEquivalentStress() (p. 938) Creates a new LinearizedEquivalentStress

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
932 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

Method AddLinearizedMaximumPrincipalStress() (p. 938) Creates a new

LinearizedMaximumPrincipalStress
Method AddLinearizedMaximumShearStress() (p. 938) Creates a new
LinearizedMaximumShearStress
Method AddLinearizedMiddlePrincipalStress() (p. 939) Creates a new
LinearizedMiddlePrincipalStress
Method AddLinearizedMinimumPrincipalStress() (p. 939) Creates a new
LinearizedMinimumPrincipalStress
Method AddLinearizedNormalStress() (p. 939) Creates a new LinearizedNormalStress
Method AddLinearizedShearStress() (p. 939) Creates a new LinearizedShearStress
Method AddLinearizedStressIntensity() (p. 939) Creates a new LinearizedStressIntensity
Method AddMaximumPrincipalElasticStrain() (p. 939) Creates a new
MaximumPrincipalElasticStrain
Method AddMaximumPrincipalStress() (p. 940) Creates a new MaximumPrincipalStress
Method AddMaximumShearElasticStrain() (p. 940) Creates a new MaximumShearElasticStrain
Method AddMaximumShearStress() (p. 940) Creates a new MaximumShearStress
Method AddMiddlePrincipalElasticStrain() (p. 940) Creates a new MiddlePrincipalElasticStrain
Method AddMiddlePrincipalStress() (p. 940) Creates a new MiddlePrincipalStress
Method AddMinimumPrincipalElasticStrain() (p. 940) Creates a new
MinimumPrincipalElasticStrain
Method AddMinimumPrincipalStress() (p. 941) Creates a new MinimumPrincipalStress
Method AddNormalElasticStrain() (p. 941) Creates a new NormalElasticStrain
Method AddNormalStress() (p. 941) Creates a new NormalStress
Method AddShearElasticStrain() (p. 941) Creates a new ShearElasticStrain
Method AddShearMomentDiagramMSUM() (p. 941) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramMY() (p. 941) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramMZ() (p. 942) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUSUM() (p. 942) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramUY() (p. 942) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramUZ() (p. 942) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVSUM() (p. 942) Creates a new TotalShearMomentDiagram
Method AddShearMomentDiagramVY() (p. 942) Creates a new
DirectionalShearMomentDiagram
Method AddShearMomentDiagramVZ() (p. 943) Creates a new
DirectionalShearMomentDiagram
Method AddShearStress() (p. 943) Creates a new ShearStress
Method AddStressIntensity() (p. 943) Creates a new StressIntensity
Method AddStressTool() (p. 943) Creates a new StressTool

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 933
Ansys.ACT.Automation.Mechanical Namespace

Method AddTotalAcceleration() (p. 943) Creates a new TotalAcceleration

Method AddTotalAxialForce() (p. 943) Creates a new TotalAxialForce
Method AddTotalBendingMoment() (p. 944) Creates a new TotalBendingMoment
Method AddTotalDeformation() (p. 944) Creates a new TotalDeformation
Method AddTotalShearForce() (p. 944) Creates a new TotalShearForce
Method AddTotalTorsionalMoment() (p. 944) Creates a new TotalTorsionalMoment
Method AddTotalVelocity() (p. 944) Creates a new TotalVelocity
Method AddUserDefinedResult() (p. 944) Creates a new UserDefinedResult
Method AddVectorAxialForce() (p. 945) Creates a new VectorAxialForce
Method AddVectorBendingMoment() (p. 945) Creates a new VectorBendingMoment
Method AddVectorPrincipalElasticStrain() (p. 945) Creates a new VectorPrincipalElasticStrain
Method AddVectorPrincipalStress() (p. 945) Creates a new VectorPrincipalStress
Method AddVectorShearForce() (p. 945) Creates a new VectorShearForce
Method AddVectorTorsionalMoment() (p. 945) Creates a new VectorTorsionalMoment
Method ClearGeneratedData() (p. 946) Run the ClearGeneratedData action.
Method Delete() (p. 946) Run the Delete action.
Method EvaluateAllResults() (p. 946) Run the EvaluateAllResults action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 946)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 947)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
934 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

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; }

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; }

AddBeamTool()
Creates a new BeamTool

Declaration Syntax
public virtual BeamTool AddBeamTool()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddContactTool()
Creates a new ContactTool

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 935
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual DirectionalShearForce AddDirectionalShearForce()

AddDirectionalTorsionalMoment()
Creates a new DirectionalTorsionalMoment

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
936 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

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

Declaration Syntax
public virtual EquivalentStress AddEquivalentStress()

AddEquivalentTotalStrain()
Creates a new EquivalentTotalStrain

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 937
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual LinearizedMaximumPrincipalStress AddLinearizedMaximumPrincipalStress()

AddLinearizedMaximumShearStress()
Creates a new LinearizedMaximumShearStress

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
938 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

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

Declaration Syntax
public virtual LinearizedStressIntensity AddLinearizedStressIntensity()

AddMaximumPrincipalElasticStrain()
Creates a new MaximumPrincipalElasticStrain

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 939
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual MiddlePrincipalStress AddMiddlePrincipalStress()

AddMinimumPrincipalElasticStrain()
Creates a new MinimumPrincipalElasticStrain

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
940 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

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

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramMSUM()

AddShearMomentDiagramMY()
Creates a new DirectionalShearMomentDiagram

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 941
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual TotalShearMomentDiagram AddShearMomentDiagramVSUM()

AddShearMomentDiagramVY()
Creates a new DirectionalShearMomentDiagram

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
942 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

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

Declaration Syntax
public virtual TotalAcceleration AddTotalAcceleration()

AddTotalAxialForce()
Creates a new TotalAxialForce

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 943
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual TotalVelocity AddTotalVelocity()

AddUserDefinedResult()
Creates a new UserDefinedResult

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
944 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombination

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

Declaration Syntax
public virtual VectorShearForce AddVectorShearForce()

AddVectorTorsionalMoment()
Creates a new VectorTorsionalMoment

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 945
Ansys.ACT.Automation.Mechanical Namespace

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)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
946 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombinationDefinition

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 260: Members

Property BaseCaseCount (p. 948) Gets the number of bases cases

Property LoadCombinationCount (p. 948) Gets the number of load combinations
Method AddBaseCase(string, Analysis, Add a BaseCase to the
double) (p. 949) SolutionCombinationDefinition
Method AddLoadCombination(string, Add a LoadCombination to the SolutionCombination
int) (p. 949) Definition
Method DeleteBaseCase(int) (p. 949) Delete a BaseCase from the
SolutionCombinationDefinition
Method DeleteLoadCombination(int) (p. 950) Delete a LoadCombination from the
SolutionCombination Definition
Method Export(string) (p. 950) Export Load Combination Definition data to Comma
Separated Value (CSV) files
Method GetBaseCaseAnalysis(int) (p. 950) Gets the BaseCase Analysis property at given index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 947
Ansys.ACT.Automation.Mechanical Namespace

Method GetBaseCaseFrequency(int) (p. 951) Gets the Frequency property from the Base Case at
given index
Method GetBaseCaseName(int) (p. 951) Gets the BaseCase Name property at given index
Method GetBaseCasePhaseAngle(int) (p. 951) Gets the Phase Angle property from the Base Case
at given index
Method GetBaseCaseTime(int) (p. 952) Gets the Time property from the Base Case at given
index
Method GetCoefficient(int, int) (p. 952) Gets the Coefficient property at given
LoadCombination index and BaseCase index
Method GetLoadCombinationName(int) (p. 952) Gets the LoadCombination Name property at given
index
Method GetLoadCombinationType(int) (p. 952) Gets the Load Combination Type property at given
index
Method Import(string) (p. 953) Import Load Combination Definition data from
Comma Separated Value (CSV) files
Method SetBaseCaseAnalysis(int, Sets the BaseCase Analysis property to given index.
Analysis) (p. 953)
Method SetBaseCaseFrequency(int, Sets the Frequency property to the Base Case at
double) (p. 953) given index
Method SetBaseCaseName(int, string) (p. 954) Sets the BaseCase Name property at given index
Method SetBaseCasePhaseAngle(int, Sets the Phase Angle property to the Base Case at
double) (p. 954) given index
Method SetBaseCaseTime(int, double) (p. 954) Sets the Time property to the Base Case at given
index
Method SetCoefficient(int, int, double) (p. 955) Sets the Coefficient property at given
LoadCombination index and BaseCase index
Method SetLoadCombinationName(int, Sets the LoadCombination Name property at given
string) (p. 955) index
Method SetLoadCombinationType(int, Sets the Load Combination Type property at given
LoadCombinationType) (p. 956) index

BaseCaseCount
Gets the number of bases cases

Declaration Syntax
public int BaseCaseCount { get; }

LoadCombinationCount
Gets the number of load combinations

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
948 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombinationDefinition

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

type(int)

Type of the Load Combination (0 for Linear, 1 for SRSS)

DeleteBaseCase(int)
Delete a BaseCase from the SolutionCombinationDefinition

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 949
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public Analysis GetBaseCaseAnalysis(int index)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
950 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombinationDefinition

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)

Parameters
index(int)

Index to get Base Case Phase Angle at

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 951
Ansys.ACT.Automation.Mechanical Namespace

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)

Parameters
index(int)

Index to get LoadCombination Name at

GetLoadCombinationType(int)
Gets the Load Combination Type property at given index

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
952 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombinationDefinition

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

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 953
Ansys.ACT.Automation.Mechanical Namespace

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)

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
954 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionCombinationDefinition

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

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 955
Ansys.ACT.Automation.Mechanical Namespace

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, IFolderDataModelObject

Table 261: Members

Property ActivateVisibility (p. 960) Gets or sets the ActivateVisibility.

Property Children (p. 960) Gets the list of children.
Property Comments (p. 960) Gets the list of associated comments.
Property Component (p. 960) Gets or sets the Component.
Property DataModelObjectCategory (p. 961) Gets the current DataModelObject's category.
Property Display (p. 961) Gets or sets the Display.
Property DisplayFilterDuringSolve (p. 961) Gets or sets the DisplayFilterDuringSolve.
Property DisplayPoints (p. 961) Gets or sets the DisplayPoints.
Property DisplayType (p. 961) Gets or sets the DisplayType.
Property DrawConnectionsAttachedTo (p. 961) Gets or sets the
DrawConnectionsAttachedTo.
Property EnvironmentSelection (p. 962) Gets or Sets the EnvironmentSelection to an
Analysis object.
Property Figures (p. 962) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
956 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

Property IdentifyElementViolations (p. 962) Gets or sets the IdentifyElementViolations.

Property Images (p. 962) Gets the list of associated images.
Property InternalObject (p. 962) Gets the internal object. For advanced usage
only.
Property LineColor (p. 962) Gets or sets the LineColor.
Property LineThickness (p. 963) Gets or sets the LineThickness.
Property ModeNumber (p. 963) Gets or sets the ModeNumber.
Property NewtonRaphsonResiduals (p. 963) Gets or sets the NewtonRaphsonResiduals.
Property ResponseConstraint (p. 963) Gets or sets the ResponseConstraint.
Property ShowChargeResiduals (p. 963) Gets or sets the ShowChargeResiduals.
Property ShowHeatResiduals (p. 963) Gets or sets the ShowHeatResiduals.
Property ShowMomentResiduals (p. 964) Gets or sets the ShowMomentResiduals.
Property SolutionOutput (p. 964) Gets or sets the SolutionOutput.
Property StepNumber (p. 964) Gets or sets the StepNumber.
Property StepSelectionMode (p. 964) Gets or sets the StepSelectionMode.
Property SummaryType (p. 964) Gets or sets the SummaryType.
Property UpdateInterval (p. 964) Gets or sets the UpdateInterval.
Property VisibleOnResults (p. 965) Gets or sets the VisibleOnResults.
Method AddAddedMass() (p. 965) Creates a new AddedMassTracker
Method AddArtificialEnergy() (p. 965) Creates a new ArtificialEnergyTracker
Method AddChattering() (p. 965) Creates a new ContactChatteringTracker
Method AddClosedPenetration() (p. 965) Creates a new
ContactClosedPenetrationTracker
Method AddComment() (p. 965) Creates a new child Comment.
Method AddContactDepth() (p. 966) Creates a new ContactDepthTracker
Method AddContactEnergy() (p. 966) Creates a new ContactEnergyTracker
Method AddContactForce() (p. 966) Creates a new ContactForceTracker
Method AddContactHeatFlux() (p. 966) Creates a new ContactHeatFluxTracker
Method AddContactingArea() (p. 966) Creates a new ContactingAreaTracker
Method AddContactMaximumNormalStiffness() (p. 966) Creates a new
ContactMaximumNormalStiffnessTracker
Method AddContactMaxTangentialFluidPressure() (p. 967) Creates a new
ContactMaxTangentialFluidPressureTracker
Method AddContactMinimumNormalStiffness() (p. 967) Creates a new
ContactMinimumNormalStiffnessTracker
Method AddContactPairForceConvergenceNorm() (p. 967) Creates a new
ContactPairForceConvergenceNormTracker
Method AddContactPressure() (p. 967) Creates a new ContactPressureTracker
Method AddDampingEnergy() (p. 967) Creates a new DampingEnergyTracker
Method AddDeformationPlotTracker() (p. 967) Creates a new TotalDeformation Plot Tracker.

Release 2022 R2 - © 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 AddDensity() (p. 968) Creates a new DensityTracker

Method AddDirectionalAcceleration() (p. 968) Creates a new DirectionalAccelerationTracker
Method AddDirectionalDeformation() (p. 968) Creates a new DirectionalDeformationTracker
Method AddDirectionalVelocity() (p. 968) Creates a new DirectionalVelocityTracker
Method AddEffectiveStrain() (p. 968) Creates a new EffectiveStrainTracker
Method AddEffectiveStress() (p. 968) Creates a new EffectiveStressTracker
Method AddElasticSlip() (p. 969) Creates a new ContactElasticSlipTracker
Method AddErodedInternalEnergy() (p. 969) Creates a new ErodedInternalEnergyTracker
Method AddErodedKineticEnergy() (p. 969) Creates a new ErodedKineticEnergyTracker
Method AddExternalForce() (p. 969) Creates a new ExternalForceTracker
Method AddFigure() (p. 969) Creates a new child Figure.
Method AddFluidPressure() (p. 969) Creates a new ContactFluidPressureTracker
Method AddForceReaction() (p. 970) Creates a new ForceReactionTracker
Method AddFrictionalDissipationEnergy() (p. 970) Creates a new
ContactFrictionalDissipationEnergyTracker
Method AddFrictionalStress() (p. 970) Creates a new ContactFrictionalStressTracker
Method AddGap() (p. 970) Creates a new ContactGapTracker
Method AddHourglassEnergy() (p. 970) Creates a new HourglassEnergyTracker
Method AddImage(string) (p. 970) 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. 971) Creates a new InternalEnergyTracker
Method AddKineticEnergy() (p. 971) Creates a new KineticEnergyTracker
Method AddLatticeDensity() (p. 971) Creates a new LatticeDensity
Method AddLatticeElementalDensity() (p. 971) Creates a new LatticeElementalDensity
Method AddMaximumDampingPressure() (p. 971) Creates a new
ContactMaximumDampingPressureTracker
Method AddMaximumGeometricSlidingDistance() (p. 972) Creates a new
ContactMaximumGeometricSlidingDistanceTracker
Method AddMaximumTangentialStiffness() (p. 972) Creates a new
ContactMaximumTangentialStiffnessTracker
Method AddMinimumGeometricSlidingDistance() (p. 972) Creates a new
ContactMinimumGeometricSlidingDistanceTracker
Method AddMinimumTangentialStiffness() (p. 972) Creates a new
ContactMinimumTangentialStiffnessTracker
Method AddMomentReaction() (p. 972) Creates a new MomentReactionTracker
Method AddMomentum() (p. 973) Creates a new MomentumTracker
Method AddNonLinearStabilizationEnergy() (p. 973) Creates a new
NonLinearStabilizationEnergyTracker
Method AddNumberContacting() (p. 973) Creates a new NumberContactingTracker

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
958 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

Method AddNumberSticking() (p. 973) Creates a new

ContactNumberStickingTracker
Method AddNumberWithLargePenetration() (p. 973) Creates a new
ContactNumberWithLargePenetrationTracker
Method AddNumberWithTooMuchSliding() (p. 973) Creates a new
ContactNumberWithTooMuchSlidingTracker
Method AddPenetration() (p. 974) Creates a new ContactPenetrationTracker
Method AddPlasticWork() (p. 974) Creates a new PlasticWorkTracker
Method AddPosition() (p. 974) Creates a new PositionTracker
Method AddPressure() (p. 974) Creates a new PressureTracker
Method AddResultingPinball() (p. 974) Creates a new
ContactResultingPinballTracker
Method AddRigidBodyVelocity() (p. 974) Creates a new RigidBodyVelocityTracker
Method AddSlidingDistance() (p. 975) Creates a new ContactSlidingDistanceTracker
Method AddSlidingIndication() (p. 975) Creates a new
ContactSlidingIndicationTracker
Method AddSpringTrackerDampingForce() (p. 975) Creates a new SpringDampingForceTracker
Method AddSpringTrackerElasticForce() (p. 975) Creates a new SpringElasticForceTracker
Method AddSpringTrackerElongation() (p. 975) Creates a new SpringElongationTracker
Method AddSpringTrackerVelocity() (p. 975) Creates a new SpringVelocityTracker
Method AddStabilizationEnergy() (p. 976) Creates a new
ContactStabilizationEnergyTracker
Method AddStiffnessEnergy() (p. 976) Creates a new StiffnessEnergyTracker
Method AddStrainEnergy() (p. 976) Creates a new ContactStrainEnergyTracker
Method AddStrainPlotTracker() (p. 976) Creates a new EquivalentElasticStrainRST Plot
Tracker.
Method AddStressPlotTracker() (p. 976) Creates a new EquivalentStress Plot Tracker.
Method AddTangentialDampingStress() (p. 976) Creates a new
ContactTangentialDampingStressTracker
Method AddTemperature() (p. 977) Creates a new TemperatureTracker
Method AddTemperaturePlotTracker() (p. 977) Creates a new TemperatureResult Plot
Tracker.
Method AddTopologyDensity() (p. 977) Creates a new TopologyDensity
Method AddTopologyElementalDensity() (p. 977) Creates a new TopologyElementalDensity
Method AddTotalEnergy() (p. 977) Creates a new TotalEnergyTracker
Method AddTotalForceFromContactPressureX() (p. 977) Creates a new
ContactTotalForceFromContactPressureXTracker
Method AddTotalForceFromContactPressureY() (p. 978) Creates a new
ContactTotalForceFromContactPressureYTracker
Method AddTotalForceFromContactPressureZ() (p. 978) Creates a new
ContactTotalForceFromContactPressureZTracker

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 959
Ansys.ACT.Automation.Mechanical Namespace

Method AddTotalForceFromTangentialStressX() (p. 978) Creates a new

ContactTotalForceFromTangentialStressXTracker
Method AddTotalForceFromTangentialStressY() (p. 978) Creates a new
ContactTotalForceFromTangentialStressYTracker
Method AddTotalForceFromTangentialStressZ() (p. 978) Creates a new
ContactTotalForceFromTangentialStressZTracker
Method AddTotalMassAverageVelocity() (p. 978) Creates a new
TotalMassAverageVelocityTracker
Method AddVolumeLossDueToWear() (p. 979) Creates a new
ContactVolumeLossDueToWearTracker
Method EvaluateAllContactTrackers() (p. 979) Run the EvaluateAllContactTrackers action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 979)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 979)
Method ImportResultTrackersFromFile(string) (p. 980) Import Result Trackers from File.
Method RenameBasedOnDefinition() (p. 980) Run the RenameBasedOnDefinition action.

ActivateVisibility
Gets or sets the ActivateVisibility.

Declaration Syntax
public bool ActivateVisibility { 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; }

Component
Gets or sets the Component.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
960 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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.

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.

Release 2022 R2 - © 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 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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
962 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 963
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
964 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

Declaration Syntax
public virtual ContactChatteringTracker AddChattering()

AddClosedPenetration()
Creates a new ContactClosedPenetrationTracker

Declaration Syntax
public virtual ContactClosedPenetrationTracker AddClosedPenetration()

AddComment()
Creates a new child Comment.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 965
Ansys.ACT.Automation.Mechanical Namespace

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

Declaration Syntax
public virtual ContactHeatFluxTracker AddContactHeatFlux()

AddContactingArea()
Creates a new ContactingAreaTracker

Declaration Syntax
public virtual ContactingAreaTracker AddContactingArea()

AddContactMaximumNormalStiffness()
Creates a new ContactMaximumNormalStiffnessTracker

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
966 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

Declaration Syntax
public virtual ContactPressureTracker AddContactPressure()

AddDampingEnergy()
Creates a new DampingEnergyTracker

Declaration Syntax
public virtual DampingEnergyTracker AddDampingEnergy()

AddDeformationPlotTracker()
Creates a new TotalDeformation Plot Tracker.

Release 2022 R2 - © 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 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

Declaration Syntax
public virtual DirectionalVelocityTracker AddDirectionalVelocity()

AddEffectiveStrain()
Creates a new EffectiveStrainTracker

Declaration Syntax
public virtual EffectiveStrainTracker AddEffectiveStrain()

AddEffectiveStress()
Creates a new EffectiveStressTracker

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
968 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

Declaration Syntax
public virtual ExternalForceTracker AddExternalForce()

AddFigure()
Creates a new child Figure.

Declaration Syntax
public virtual Figure AddFigure()

AddFluidPressure()
Creates a new ContactFluidPressureTracker

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 969
Ansys.ACT.Automation.Mechanical Namespace

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

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
970 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

Declaration Syntax
public virtual LatticeDensity AddLatticeDensity()

AddLatticeElementalDensity()
Creates a new LatticeElementalDensity

Declaration Syntax
public virtual LatticeElementalDensity AddLatticeElementalDensity()

AddMaximumDampingPressure()
Creates a new ContactMaximumDampingPressureTracker

Release 2022 R2 - © 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 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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
972 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 973
Ansys.ACT.Automation.Mechanical Namespace

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()

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
974 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 975
Ansys.ACT.Automation.Mechanical Namespace

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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
976 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 977
Ansys.ACT.Automation.Mechanical Namespace

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

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
978 of ANSYS, Inc. and its subsidiaries and affiliates.
 SolutionInformation

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 979
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.)

ImportResultTrackersFromFile(string)
Import Result Trackers from File.

Declaration Syntax
public virtual void ImportResultTrackersFromFile(string fileName)

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 262: Members

Property Behavior (p. 981) Gets the Behavior.

Property Children (p. 982) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
980 of ANSYS, Inc. and its subsidiaries and affiliates.
 Stage

Property Comments (p. 982) Gets the list of associated

comments.
Property CyclicRegion (p. 982) Gets or sets the CyclicRegion.
Property DataModelObjectCategory (p. 982) Gets the current
DataModelObject's category.
Property Figures (p. 982) Gets the list of associated figures.
Property Images (p. 982) Gets the list of associated images.
Property InternalObject (p. 983) Gets the internal object. For
advanced usage only.
Property Location (p. 983) Gets or sets the Location.
Property StageName (p. 983) Gets the StageName.
Property Suppressed (p. 983) Gets or sets the Suppressed.
Method AddComment() (p. 983) Creates a new child Comment.
Method AddFigure() (p. 983) Creates a new child Figure.
Method AddImage(string) (p. 984) 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. 984) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by
IList<ChildrenType>) (p. 984) type.
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by
IList<IDataModelObject>) (p. 984) type.
Method GetHarmonicIndexForEnvironmentByIndex(uint, Gets the worksheet harmonic index
int) (p. 985) for a given environment at index.
Method GetHarmonicIndexNumberForEnvironment(uint) (p. 985) Gets the worksheet number of
harmonic indexes for a given
environment.
Method SetHarmonicIndexForEnvironmentByIndex(uint, int, Sets the worksheet harmonic index
uint) (p. 986) for a given environment at index.
Method SetHarmonicIndexNumberForEnvironment(uint, Sets the worksheet number of
uint) (p. 986) harmonic indexes for a given
environment.

Behavior
Gets the Behavior.

Declaration Syntax
public StageBehavior Behavior { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 981
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; }

CyclicRegion
Gets or sets the CyclicRegion.

Declaration Syntax
public SymmetryGeneral CyclicRegion { 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
982 of ANSYS, Inc. and its subsidiaries and affiliates.
 Stage

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; }

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 983
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
984 of ANSYS, Inc. and its subsidiaries and affiliates.
 Stage

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)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 985
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
986 of ANSYS, Inc. and its subsidiaries and affiliates.
 STL

Declaration Syntax
public class STL : GeometryFileContainer

Table 263: Members

Property Children (p. 449) Gets the list of children.

(Inherited from
GeometryFileContainer (p. 448).)
Property Color (p. 988) Gets or sets the Color.
Property Comments (p. 449) Gets the list of associated comments.

(Inherited from
GeometryFileContainer (p. 448).)
Property DataModelObjectCategory (p. 988)Gets the current DataModelObject's
category.
Property Figures (p. 449) Gets the list of associated figures.

(Inherited from
GeometryFileContainer (p. 448).)
Property FileName (p. 988) Gets or sets the FileName.
Property Images (p. 449) Gets the list of associated images.

Property InternalObject (p. 988)
Property LengthUnits (p. 450)
(Inherited from
GeometryFileContainer (p. 448).)
Gets the internal object. For advanced usage
only.
Gets or sets the LengthUnits.

(Inherited from
GeometryFileContainer (p. 448).)
Property ShowAlways (p. 450) Gets or sets the ShowAlways.

(Inherited from
GeometryFileContainer (p. 448).)
Property Statistics (p. 450) Gets the Statistics.

(Inherited from
GeometryFileContainer (p. 448).)
Property Suppressed (p. 450) Gets or sets the Suppressed.

(Inherited from
GeometryFileContainer (p. 448).)
Property TranslateX (p. 988) Gets or sets the TranslateX.
Property TranslateY (p. 988) Gets or sets the TranslateY.
Property TranslateZ (p. 989) Gets or sets the TranslateZ.
Method ExportStl(string, Progress) (p. 989) Export STL data.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 987
Ansys.ACT.Automation.Mechanical Namespace

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
988 of ANSYS, Inc. and its subsidiaries and affiliates.
 SubstructureGenerationCondensedPart

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.

SubstructureGenerationCondensedPart
Defines a SubstructureGenerationCondensedPart.

Declaration Syntax
public class SubstructureGenerationCondensedPart : CondensedPartBase

Table 264: Members

Property AttachmentMethod (p. 991) Gets or sets the AttachmentMethod.

Property Children (p. 258) Gets the list of children.

(Inherited from CondensedPartBase (p. 257).)

Property Comments (p. 258) Gets the list of associated comments.

(Inherited from CondensedPartBase (p. 257).)

Property DataModelObjectCategory (p. 991)Gets the current DataModelObject's
category.
Property Figures (p. 258) Gets the list of associated figures.

(Inherited from CondensedPartBase (p. 257).)

Property GenerateDampingMatrix (p. 991) Gets or sets the GenerateDampingMatrix.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 989
Ansys.ACT.Automation.Mechanical Namespace

Property GeometrySelection (p. 259) Gets or sets the GeometrySelection.

(Inherited from CondensedPartBase (p. 257).)

Property Images (p. 259) Gets the list of associated images.

(Inherited from CondensedPartBase (p. 257).)

Property InterfaceMethod (p. 991) Gets or sets the InterfaceMethod.
Property Interfaces (p. 991) Returns the Interfaces of the condensed part
Property InternalObject (p. 991) Gets the internal object. For advanced usage
only.
Property LumpedMassFormulation (p. 992) Gets or sets the LumpedMassFormulation.
Property NumberInterfaceEntries (p. 259) Gets the NumberInterfaceEntries.

(Inherited from CondensedPartBase (p. 257).)

Property NumberMasterNodes (p. 259) Gets the NumberMasterNodes.

(Inherited from CondensedPartBase (p. 257).)

Property Physics (p. 259) Gets the Physics.

(Inherited from CondensedPartBase (p. 257).)

Property PointMassTreatment (p. 992) Gets or sets the PointMassTreatment.
Property ReductionMethod (p. 992) Gets or sets the ReductionMethod.
Property ReferenceTemperature (p. 260) Gets or sets the ReferenceTemperature.

(Inherited from CondensedPartBase (p. 257).)

Property SolutionName (p. 260) Gets or sets the SolutionName.

(Inherited from CondensedPartBase (p. 257).)

Property SolutionNameMode (p. 260) Gets or sets the SolutionNameMode.

(Inherited from CondensedPartBase (p. 257).)

Property SolverFilesDirectory (p. 260) Gets the SolverFilesDirectory.

(Inherited from CondensedPartBase (p. 257).)

Property SolverUnits (p. 260) Gets or sets the SolverUnits.

(Inherited from CondensedPartBase (p. 257).)

Property SolverUnitSystem (p. 260) Gets or sets the SolverUnitSystem.

(Inherited from CondensedPartBase (p. 257).)

Property Suppressed (p. 261) Gets or sets the Suppressed.

(Inherited from CondensedPartBase (p. 257).)

Property TemperatureUnits (p. 261) Gets the TemperatureUnits.

(Inherited from CondensedPartBase (p. 257).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
990 of ANSYS, Inc. and its subsidiaries and affiliates.
 SubstructureGenerationCondensedPart

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 991
Ansys.ACT.Automation.Mechanical Namespace

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; }

Surface
Defines a Surface.

Declaration Syntax
public class Surface : DataModelObject, ISelectionInfo, IFolderDataModelObject

Table 265: Members

Property Children (p. 993) Gets the list of children.

Property Comments (p. 993) Gets the list of associated comments.
Property CoordinateSystem (p. 993) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 993) Gets the current DataModelObject's category.
Property Figures (p. 993) Gets the list of associated figures.
Property Images (p. 994) Gets the list of associated images.
Property InternalObject (p. 994) Gets the internal object. For advanced usage only.
Property Suppressed (p. 994) Gets or sets the Suppressed.
Method AddComment() (p. 994) Creates a new child Comment.
Method AddFigure() (p. 994) Creates a new child Figure.
Method AddImage(string) (p. 994) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
992 of ANSYS, Inc. and its subsidiaries and affiliates.
 Surface

image will be a screen capture of the Geometry

window.
Method Delete() (p. 995) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 995)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 995)

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; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 993
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 IDSSurfaceAuto 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.

Declaration Syntax
public virtual Image AddImage(string filePath)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
994 of ANSYS, Inc. and its subsidiaries and affiliates.
 Surface

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 995
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.)

SurfaceCoating
Defines a SurfaceCoating.

Declaration Syntax
public class SurfaceCoating : ImportedDataModelObject, IFolderDataModelObject

Table 266: Members

Property Children (p. 997) Gets the list of children.

Property Comments (p. 997) Gets the list of associated comments.
Property CoordinateSystem (p. 997) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 997) Gets the current DataModelObject's category.
Property Figures (p. 997) Gets the list of associated figures.
Property Images (p. 997) Gets the list of associated images.
Property InternalObject (p. 998) Gets the internal object. For advanced usage only.
Property Location (p. 998) Gets or sets the Location.
Property Material (p. 998) Gets or sets the Material.
Property Suppressed (p. 998) Gets or sets the Suppressed.
Property SurfaceCoatingStiffnessBehavior (p. 998) Gets or sets the SurfaceCoatingStiffnessBehavior.
Property Thickness (p. 998) Gets or sets the Thickness.
Method AddComment() (p. 999) Creates a new child Comment.
Method AddFigure() (p. 999) Creates a new child Figure.
Method AddImage(string) (p. 999) 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. 999) Run the Delete action.
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. 1000)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
996 of ANSYS, Inc. and its subsidiaries and affiliates.
 SurfaceCoating

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; }

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 997
Ansys.ACT.Automation.Mechanical Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
998 of ANSYS, Inc. and its subsidiaries and affiliates.
 SurfaceCoating

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 2022 R2 - © 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
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.)

Symmetry
Defines a Symmetry.

Declaration Syntax
public class Symmetry : ImportedDataModelObject, IFolderDataModelObject

Table 267: Members

Property Children (p. 1001) Gets the list of children.

Property Comments (p. 1001) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1001) Gets the current DataModelObject's category.
Property Figures (p. 1002) Gets the list of associated figures.
Property Images (p. 1002) Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1000 of ANSYS, Inc. and its subsidiaries and affiliates.
 Symmetry

Property InternalObject (p. 1002) Gets the internal object. For advanced usage only.
Method AddComment() (p. 1002) Creates a new child Comment.
Method AddCyclicRegion() (p. 1002) Creates a new CyclicRegion
Method AddFigure() (p. 1002) Creates a new child Figure.
Method AddGeneralAxisymmetric() (p. 1003) Creates a new GeneralAxisymmetric
Method AddImage(string) (p. 1003) 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. 1003) Creates a new SymmetryRegion
Method AddPeriodicRegion() (p. 1003) Creates a new PeriodicRegion
Method AddPreMeshedCyclicRegion() (p. 1003) Creates a new PreMeshedCyclicRegion
Method AddStage() (p. 1004) Creates a new Stage
Method AddSymmetryRegion() (p. 1004) Creates a new SymmetryRegion
Method Delete() (p. 1004) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1004)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1004)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1001
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 IDSSymmetryGroupAuto InternalObject { get; }

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1002 of ANSYS, Inc. and its subsidiaries and affiliates.
 Symmetry

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.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1003
Ansys.ACT.Automation.Mechanical Namespace

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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1004 of ANSYS, Inc. and its subsidiaries and affiliates.
 SymmetryGeneral

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.

Declaration Syntax
public class SymmetryGeneral : ImportedDataModelObject, IFolderDataModelObject

Table 268: Members

Property Children (p. 1006) Gets the list of children.

Property Comments (p. 1006) Gets the list of associated comments.
Property CoordinateSystem (p. 1006) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1006) Gets the current DataModelObject's category.
Property Figures (p. 1006) Gets the list of associated figures.
Property HighBoundaryLocation (p. 1007) Gets or sets the HighBoundaryLocation.
Property Images (p. 1007) Gets the list of associated images.
Property InternalObject (p. 1007) Gets the internal object. For advanced usage only.
Property Location (p. 1007) Gets or sets the Location.
Property LowBoundaryLocation (p. 1007) Gets or sets the LowBoundaryLocation.
Property ScopeMode (p. 1007) Gets the ScopeMode.
Property Suppressed (p. 1008) Gets or sets the Suppressed.
Method AddComment() (p. 1008) Creates a new child Comment.
Method AddFigure() (p. 1008) Creates a new child Figure.
Method AddImage(string) (p. 1008) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1005
Ansys.ACT.Automation.Mechanical Namespace

image will be a screen capture of the Geometry

window.
Method Delete() (p. 1008) Run the Delete action.
Method FlipHighLow() (p. 1009) Flips the High and Low Boundaries.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1009)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1009)

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; }

Figures
Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1006 of ANSYS, Inc. and its subsidiaries and affiliates.
 SymmetryGeneral

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1007
Ansys.ACT.Automation.Mechanical Namespace

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1008 of ANSYS, Inc. and its subsidiaries and affiliates.
 SymmetryGeneral

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1009
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.)

SymmetryManufacturingConstraint
Defines a SymmetryManufacturingConstraint.

Declaration Syntax
public class SymmetryManufacturingConstraint : ManufacturingConstraint

Table 269: Members

Property Axis (p. 1010) Gets or sets the Axis.

Property Children (p. 556) Gets the list of children.

(Inherited from
ManufacturingConstraint (p. 556).)
Property CoordinateSystem (p. 1010) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1011)Gets the current DataModelObject's
category.
Property InternalObject (p. 1011) Gets the internal object. For advanced usage
only.
Property Location (p. 1011) Gets or sets the Location.
Property ScopingMethod (p. 1011) Gets or sets the ScopingMethod.
Property Selection (p. 557) Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

Axis
Gets or sets the Axis.

Declaration Syntax
public CoordinateSystemAxisType Axis { set;get; }

CoordinateSystem
Gets or sets the CoordinateSystem.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1010 of ANSYS, Inc. and its subsidiaries and affiliates.
 SymmetryRegion

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; }

ScopingMethod
Gets or sets the ScopingMethod.

Declaration Syntax
public GeometryDefineByType ScopingMethod { set;get; }

SymmetryRegion
Defines a SymmetryRegion.

Declaration Syntax
public class SymmetryRegion : SymmetryGeneral

Table 270: Members

Property ApplyTo (p. 1012) Gets or sets the ApplyTo.

Property Behavior (p. 1013) Gets or sets the Behavior.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1011
Ansys.ACT.Automation.Mechanical Namespace
Property Children (p. 1006)
Property Comments (p. 1006)
Property CoordinateSystem (p. 1006)
Property DataModelObjectCategory (p. 1013)Gets the current DataModelObject's
category.
Property Figures (p. 1006)
Property HighBoundaryLocation (p. 1007)
Property Images (p. 1007)
Property InternalObject (p. 1013)
Property LinearShift (p. 1013)
Property Location (p. 1013)
Property LowBoundaryLocation (p. 1007)
Property PeriodicityDirection (p. 1013)
Property ScopeMode (p. 1007)
Property Suppressed (p. 1008)
Property SymmetryNormal (p. 1014)
Property Type (p. 1014)
ApplyTo
Gets or sets the ApplyTo.
Declaration Syntax
public PeriodicApplyTo ApplyTo { set;get; }
Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1012
Gets the list of children.
(Inherited from SymmetryGeneral (p. 1005).)
Gets the list of associated comments.
(Inherited from SymmetryGeneral (p. 1005).)
Gets or sets the CoordinateSystem.
(Inherited from SymmetryGeneral (p. 1005).)
Gets the list of associated figures.
(Inherited from SymmetryGeneral (p. 1005).)
Gets or sets the HighBoundaryLocation.
(Inherited from SymmetryGeneral (p. 1005).)
Gets the list of associated images.
(Inherited from SymmetryGeneral (p. 1005).)
Gets the internal object. For advanced usage
only.
Gets or sets the LinearShift.
Gets or sets the Location.
Gets or sets the LowBoundaryLocation.
(Inherited from SymmetryGeneral (p. 1005).)
Gets or sets the PeriodicityDirection.
Gets the ScopeMode.
(Inherited from SymmetryGeneral (p. 1005).)
Gets or sets the Suppressed.
(Inherited from SymmetryGeneral (p. 1005).)
Gets or sets the SymmetryNormal.
Gets or sets the Type.
of ANSYS, Inc. and its subsidiaries and affiliates.
 SymmetryRegion

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1013
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public class Table : DataModelObject, IDataTable, IEnumerable<IDataSeries>, IEnumerable, IFolder-
DataModelObject

Table 271: Members

Property Children (p. 1015) Gets the list of children.

Property Comments (p. 1015) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1015) Gets the current DataModelObject's category.
Property Figures (p. 1015) Gets the list of associated figures.
Property Images (p. 1016) Gets the list of associated images.
Property InternalObject (p. 1016) Gets the internal object. For advanced usage only.
Method AddComment() (p. 1016) Creates a new child Comment.
Method AddFigure() (p. 1016) Creates a new child Figure.
Method AddImage(string) (p. 1016) 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. 1017)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1017)
Method GetDataURI() (p. 1018) Gets the data URI from which the tabular data was
imported.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1014 of ANSYS, Inc. and its subsidiaries and affiliates.
 Table

Method GetImportSettings() (p. 1018)
Method Import(string, ImportFormat,
ImportSettingsBase) (p. 1018)
Get the settings used for an import operation. `null`
will be returned if an import operation has not yet
been performed.
Import data from the provided resource into the
table as specified by format and settings. All
existing data will be overwritten upon import.

If “settings” is `None` then the default settings class,

as provided by
ImportSettingsHelper.GetSettingsForFormat(), will
be used.

All imported data in textual/string format will

depend on the .NET `double.TryParse()` method to
convert items into a suitable value for variable
storage in the table. An “undefined” value (as
specified in the `IDataTable` API spec) will be used
if a suitable double representation cannot be
parsed.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1015
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 IDSTableAuto 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1016 of ANSYS, Inc. and its subsidiaries and affiliates.
 Table

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1017
Ansys.ACT.Automation.Mechanical Namespace

GetDataURI()
Gets the data URI from which the tabular data was imported.

Declaration Syntax
public virtual string GetDataURI()

GetImportSettings()
Get the settings used for an import operation. `null` will be returned if an import operation has not
yet been performed.

Declaration Syntax
public virtual ImportSettingsBase GetImportSettings()

Import(string, ImportFormat, ImportSettingsBase)

Import data from the provided resource into the table as specified by format and settings. All existing
data will be overwritten upon import.

If “settings” is `None` then the default settings class, as provided by ImportSettingsHelper.GetSettings-

ForFormat(), will be used.

All imported data in textual/string format will depend on the .NET `double.TryParse()` method to
convert items into a suitable value for variable storage in the table. An “undefined” value (as specified
in the `IDataTable` API spec) will be used if a suitable double representation cannot be parsed.

Declaration Syntax
public virtual IReadOnlyList<IDataSeries> Import(string dataURI, ImportFormat format, ImportSettings-
Base 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1018 of ANSYS, Inc. and its subsidiaries and affiliates.
 TableGroup

TableGroup
Defines a TableGroup.

Declaration Syntax
public class TableGroup : DataModelObject, IFolderDataModelObject

Table 272: Members

Property Children (p. 1019) Gets the list of children.

Property Comments (p. 1019) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1019) Gets the current DataModelObject's category.
Property Figures (p. 1020) Gets the list of associated figures.
Property Images (p. 1020) Gets the list of associated images.
Property InternalObject (p. 1020) Gets the internal object. For advanced usage only.
Method AddComment() (p. 1020) Creates a new child Comment.
Method AddFigure() (p. 1020) Creates a new child Figure.
Method AddImage(string) (p. 1020) 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. 1021)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1021)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1019
Ansys.ACT.Automation.Mechanical 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 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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1020 of ANSYS, Inc. and its subsidiaries and affiliates.
 TableGroup

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)

Parameters
category(DataModelObjectCategory)

The category of the data model object to retrieve.

recurses(bool)

Whether to retrieve grandchildren recursively.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1021
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.)

TCrossSection
Defines a TCrossSection.

Declaration Syntax
public class TCrossSection : CrossSection

Table 273: Members

Property Area (p. 1022) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 1023)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 1023) Gets the internal object. For advanced usage
only.
Property IYY (p. 1023) Gets the IYY.
Property IZZ (p. 1023) Gets the IZZ.
Property Thick1 (p. 1023) Gets or sets the Thick1.
Property Thick2 (p. 1023) Gets or sets the Thick2.
Property Width1 (p. 1024) Gets or sets the Width1.
Property Width2 (p. 1024) Gets or sets the Width2.

Area
Gets the Area.

Declaration Syntax
public Quantity Area { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1022 of ANSYS, Inc. and its subsidiaries and affiliates.
 TCrossSection

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.

Declaration Syntax
public Quantity Thick2 { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1023
Ansys.ACT.Automation.Mechanical Namespace

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 274: Members

Property Children (p. 809) Gets the list of children.

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 1024)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 1025) Gets the internal object. For advanced usage only.
Property Location (p. 1025) Gets or sets the Location.
Property ScopingMethod (p. 1025) Gets or sets the ScopingMethod.
Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

Property TemperatureAbsMax (p. 1025) Gets or sets the TemperatureAbsMax.

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1024 of ANSYS, Inc. and its subsidiaries and affiliates.
 ThermalComplianceConstraint

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.

Declaration Syntax
public Field TemperatureAbsMax { get; }

ThermalComplianceConstraint
Defines a ThermalComplianceConstraint.

Declaration Syntax
public class ThermalComplianceConstraint : ResponseConstraint

Table 275: Members

Property Children (p. 809) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1025
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ResponseConstraint (p. 809).)

Property ComplianceLimit (p. 1026) Gets or sets the ComplianceLimit.
Property DataModelObjectCategory (p. 1026)Gets the current DataModelObject's category.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 1026) Gets the internal object. For advanced usage only.
Property Suppressed (p. 810) Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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; }

ThermalPointMass
Defines a ThermalPointMass.

Declaration Syntax
public class ThermalPointMass : GenericPointMass

Table 276: Members

Property AppliedBy (p. 1027) Gets or sets the AppliedBy.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1026 of ANSYS, Inc. and its subsidiaries and affiliates.
 ThermalPointMass

Property Behavior (p. 1027) Gets or sets the Behavior.

Property Children (p. 425) Gets the list of children.

(Inherited from GenericPointMass (p. 424).)

Property Comments (p. 425) Gets the list of associated comments.

(Inherited from GenericPointMass (p. 424).)

Property CoordinateSystem (p. 1028) Gets or sets the CoordinateSystem.
Property DataModelObjectCategory (p. 1028)Gets the current DataModelObject's category.
Property Figures (p. 425) Gets the list of associated figures.

(Inherited from GenericPointMass (p. 424).)

Property Images (p. 426) Gets the list of associated images.

(Inherited from GenericPointMass (p. 424).)

Property InternalObject (p. 1028) Gets the internal object. For advanced usage
only.
Property IsDistributedMass (p. 426) Gets the IsDistributedMass.

(Inherited from GenericPointMass (p. 424).)

Property Location (p. 426) Gets or sets the Geometry.

(Inherited from GenericPointMass (p. 424).)

Property PinballRegion (p. 1028) Gets or sets the PinballRegion.
Property RemotePoint (p. 426) Gets the remote point associated to the point
mass.

(Inherited from GenericPointMass (p. 424).)

Property Suppressed (p. 1028) Gets or sets the Suppressed.
Property ThermalCapacitance (p. 1028) Gets or sets the ThermalCapacitance.
Method PromoteToRemotePoint() (p. 1029) Run the PromoteToRemotePoint action.

AppliedBy
Gets or sets the AppliedBy.

Declaration Syntax
public RemoteApplicationType AppliedBy { set;get; }

Behavior
Gets or sets the Behavior.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1027
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1028 of ANSYS, Inc. and its subsidiaries and affiliates.
 Thickness

Declaration Syntax
public Quantity ThermalCapacitance { set;get; }

PromoteToRemotePoint()
Run the PromoteToRemotePoint action.

Declaration Syntax
public virtual IEnumerable<RemotePoint> PromoteToRemotePoint()

Thickness
Defines a Thickness.

Declaration Syntax
public class Thickness : ImportedDataModelObject, IFolderDataModelObject

Table 277: Members

Property Children (p. 1030) Gets the list of children.

Property Comments (p. 1030) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1030) Gets the current DataModelObject's category.
Property Figures (p. 1030) Gets the list of associated figures.
Property Images (p. 1030) Gets the list of associated images.
Property IndependentVariable (p. 1031) Gets or sets the IndependentVariable.
Property InternalObject (p. 1031) Gets the internal object. For advanced usage only.
Property Location (p. 1031) Gets or sets the Location.
Property MembraneOffset (p. 1031) Gets or sets the MembraneOffset.
Property NumberOfSegments (p. 1031) Gets or sets the NumberOfSegments.
Property OffsetType (p. 1031) Gets or sets the OffsetType.
Property RangeMaximum (p. 1032) Gets or sets the RangeMaximum.
Property RangeMinimum (p. 1032) Gets or sets the RangeMinimum.
Property ScopeMode (p. 1032) Gets the ScopeMode.
Property Suppressed (p. 1032) Gets or sets the Suppressed.
Property ThicknessField (p. 1032) Gets or sets the ThicknessField.
Property XYZFunctionCoordinateSystem (p. 1032) Gets or sets the XYZFunctionCoordinateSystem.
Method AddComment() (p. 1033) Creates a new child Comment.
Method AddFigure() (p. 1033) Creates a new child Figure.
Method AddImage(string) (p. 1033) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1029
Ansys.ACT.Automation.Mechanical Namespace

image will be a screen capture of the Geometry

window.
Method Delete() (p. 1033) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1033)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1034)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1030 of ANSYS, Inc. and its subsidiaries and affiliates.
 Thickness

IndependentVariable
Gets or sets the IndependentVariable.

Declaration Syntax
public LoadVariableVariationType IndependentVariable { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1031
Ansys.ACT.Automation.Mechanical Namespace

RangeMaximum
Gets or sets the RangeMaximum.

Declaration Syntax
public Quantity RangeMaximum { set;get; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1032 of ANSYS, Inc. and its subsidiaries and affiliates.
 Thickness

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1033
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.)

Tree
No details are provided for this entry.

Declaration Syntax
public class Tree : ACTMarshalByRefObject, IEnumerable

Table 278: Members

Property ActiveObjects (p. 1035) Gets a list of all selected objects.

Property AllObjects (p. 1035) Gets a list of all objects available in the tree.
Property CurrentFilter (p. 1036) Gets the current filter applied on the tree.
Property CurrentSearchGraphics (p. 1036) Gets the current visibility.
Property CurrentSearchState (p. 1036) Gets the current search state.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1034 of ANSYS, Inc. and its subsidiaries and affiliates.
 Tree

Property CurrentSearchString (p. 1036) Gets the current search string (name/tag).
Property FirstActiveObject (p. 1036) Gets the first object selected in the tree.
Property GroupingFoldersVisible (p. 1036) Controls whether or not group folders are visible.
Method Activate(IDataModelObject) (p. 1037) selects an object in the tree.
Method Activate(IEnumerable<IDataModelObject>) (p. 1037)Multi-selects a list of objects in the tree.
Method ClearFilter() (p. 1037) Clears the current filter.
Method ClearSort() (p. 1037) Clears the current sort.
Method Filter(string, string, ObjectState, VisibilityType, Filters the tree objects based on given parameters.
TreeFilterObjectClass, CoordinateSystem, string,
Analysis, TreeFilterScopingType,
TreeFilterObjectState) (p. 1038)
Method Find(string, Func<IDataModelObject, bool>, Gets a list of all objects with the specified parameters.
string, ObjectState) (p. 1039)
Method GetPathToFirstActiveObject() (p. 1039) Gets the full path that needs to be typed in order to go to
Method Group(IDataModelObject) (p. 1039) Moves dataModelObject to new tree grouping folder.
Method Group(IEnumerable) (p. 1040) Groups a list of objects together.
Method IsSorted() (p. 1040) Checks if the tree is currently sorted alphabetically.
Method Refresh() (p. 1040) Refreshes the tree.
Method Sort(SortingType, bool) (p. 1040) 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: 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.Find(type=SortingTy

Method Suspend() ***OBSOLETE*** Use 'Transaction' Prevents the tree from being updated.
instead. (p. 1041)

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.

Release 2022 R2 - © 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 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.

Declaration Syntax
public ObjectState CurrentSearchState { get; }

CurrentSearchString
Gets the current search string (name/tag).

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1036 of ANSYS, Inc. and its subsidiaries and affiliates.
 Tree

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.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1037
Ansys.ACT.Automation.Mechanical Namespace

Filter(string, string, ObjectState, VisibilityType, TreeFilterObjectClass, Co-

ordinateSystem, string, Analysis, TreeFilterScopingType, TreeFilterObject-
State)
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)

Parameters
name(string)

Filter by a given name.

tag(string)

Filter by a given tag.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1038 of ANSYS, Inc. and its subsidiaries and affiliates.
 Tree

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)

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

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1039
Ansys.ACT.Automation.Mechanical Namespace

Group(IEnumerable)
Groups a list of objects together.

Declaration Syntax
public TreeGroupingFolder Group(IEnumerable dataModelObjects)

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.Find(type=SortingType.Alphabetical, reverse=False)

Declaration Syntax
public void Sort(SortingType type, bool reverse)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1040 of ANSYS, Inc. and its subsidiaries and affiliates.
 TreeGroupingFolder

Parameters
type(SortingType)

No details are provided for this entry.

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()

TreeGroupingFolder
Defines a TreeGroupingFolder.

Declaration Syntax
public class TreeGroupingFolder : ImportedDataModelObject, IFolderDataModelObject

Table 279: Members

Property Children (p. 1041) Gets the list of children.

Property ChildrenInGroup (p. 1042) Gets the ChildrenInGroup.
Property DataModelObjectCategory (p. 1042) Gets the current DataModelObject's
category.
Property InternalObject (p. 1042) Gets the internal object. For advanced
usage only.
Property Suppressed (p. 1042) Gets or sets the Suppressed.
Method DeleteTreeGroupAndChildren() (p. 1042) Run the DeleteTreeGroupAndChildren
action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1042)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1043)
Method Ungroup() (p. 1043) Run the Ungroup action.

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1041
Ansys.ACT.Automation.Mechanical Namespace

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.

Declaration Syntax
public virtual void DeleteTreeGroupAndChildren()

GetChildren<ChildrenType>(bool, IList<ChildrenType>)
Gets the list of children, filtered by type.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1042 of ANSYS, Inc. and its subsidiaries and affiliates.
 TreeGroupingFolder

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.)

Ungroup()
Run the Ungroup action.

Declaration Syntax
public virtual void Ungroup()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1043
Ansys.ACT.Automation.Mechanical Namespace

UniformConstraint
Defines a UniformConstraint.

Declaration Syntax
public class UniformConstraint : ManufacturingConstraint

Table 280: Members

Property Axis (p. 1044) Gets or sets the Axis.

Property Children (p. 556) Gets the list of children.

Property CoordinateSystem (p. 1044)
Property DataModelObjectCategory (p. 1045)Gets the current DataModelObject's
category.
Property InternalObject (p. 1045)
Property Location (p. 1045)
Property ScopingMethod (p. 1045)
Property Selection (p. 557)
(Inherited from
ManufacturingConstraint (p. 556).)
Gets or sets the CoordinateSystem.
Gets the internal object. For advanced usage
only.
Gets or sets the Location.
Gets or sets the ScopingMethod.
Gets or sets the Selection.

(Inherited from
ManufacturingConstraint (p. 556).)
Property Suppressed (p. 557) Gets or sets the Suppressed.

(Inherited from
ManufacturingConstraint (p. 556).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1044 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 281: Members

Property Area (p. 1046) Gets or sets the Area.

Property CGy (p. 1046) Gets or sets the CGy.
Property CGZ (p. 1046) Gets or sets the CGZ.
Property Children (p. 323) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1045
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 1047)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 1047) Gets the internal object. For advanced usage
only.
Property Iw (p. 1047) Gets or sets the Iw.
Property Iyy (p. 1047) Gets or sets the Iyy.
Property Izz (p. 1047) Gets or sets the Izz.
Property J (p. 1047) Gets or sets the J.
Property SHy (p. 1048) Gets or sets the SHy.
Property SHz (p. 1048) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1046 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1047
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 282: Members

Property Children (p. 1049) Gets the list of children.

Property Comments (p. 1049) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1049) Gets the current DataModelObject's category.
Property Figures (p. 1049) Gets the list of associated figures.
Property Geometry (p. 1049) Gets the Geometry.
Property Images (p. 1049) Gets the list of associated images.
Property InternalObject (p. 1050) Gets the internal object. For advanced usage only.
Property ProjectToUnderlyingGeometry (p. 1050) Gets or sets the ProjectToUnderlyingGeometry.
Property VTClass (p. 1050) Gets the VTClass.
Method AddComment() (p. 1050) Creates a new child Comment.
Method AddFigure() (p. 1050) Creates a new child Figure.
Method AddImage(string) (p. 1050) 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. 1051) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1051)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1048 of ANSYS, Inc. and its subsidiaries and affiliates.
 VirtualCell

Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.

bool, IList<IDataModelObject>) (p. 1051)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1049
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1050 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1051
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 283: Members

Property AspectRatio (p. 1054) Gets or sets the AspectRatio.

Property AutomaticBehavior (p. 1054) Gets or sets the Behavior when Method
is set to "Automatic".
Property Children (p. 1054) Gets the list of children.
Property Comments (p. 1054) Gets the list of associated comments.
Property ContactAngle (p. 1054) Gets or sets the ContactAngle.
Property CustomFeatureAngle (p. 1054) Gets or sets the CustomFeatureAngle.
Property DataModelObjectCategory (p. 1055) Gets the current DataModelObject's
category.
Property EdgeAngle (p. 1055) Gets or sets the EdgeAngle.
Property Figures (p. 1055) Gets the list of associated figures.
Property GaussAngle (p. 1055) Gets or sets the GaussAngle.
Property GenerateOnUpdate (p. 1055) Gets or sets the GenerateOnUpdate.
Property Images (p. 1055) Gets the list of associated images.
Property InternalObject (p. 1056) Gets the internal object. For advanced
usage only.
Property LockPositionOfDependentEdgeSplits (p. 1056) Gets or sets the
LockPositionOfDependentEdgeSplits.
Property MaxEdgeLength (p. 1056) Gets or sets the MaxEdgeLength.
Property MaxFaceArea (p. 1056) Gets or sets the MaxFaceArea.
Property MaxSliverWidth (p. 1056) Gets or sets the MaxSliverWidth.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1052 of ANSYS, Inc. and its subsidiaries and affiliates.
 VirtualTopology

Property MergeFaceEdges (p. 1056) Gets or sets the MergeFaceEdges.

Property Method (p. 1057) Gets or sets the Method.
Property MinEdgeLength (p. 1057) Gets or sets the MinEdgeLength.
Property MinFaceArea (p. 1057) Gets or sets the MinFaceArea.
Property MinSliverWidth (p. 1057) Gets or sets the MinSliverWidth.
Property RepairBehavior (p. 1057) Gets or sets the Behavior when Method
is set to "Repair".
Property SharedBoundaryRatio (p. 1057) Gets or sets the SharedBoundaryRatio.
Property SimplifyFaces (p. 1058) Gets or sets the SimplifyFaces.
Property VirtualEdges (p. 1058) Gets the VirtualEdges.
Property VirtualEntities (p. 1058) Gets the VirtualEntities.
Property VirtualFaces (p. 1058) Gets the VirtualFaces.
Property VirtualHardVertex (p. 1058) Gets the VirtualHardVertex.
Property VirtualSplitEdges (p. 1058) Gets the VirtualSplitEdges.
Property VirtualSplitFaces (p. 1059) Gets the VirtualSplitFaces.
Method AddComment() (p. 1059) Creates a new child Comment.
Method AddFigure() (p. 1059) Creates a new child Figure.
Method AddImage(string) (p. 1059) 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. 1059) Add Virtual Cell.
Method AddVirtualHardVertex(ISelectionInfo, Add Virtual Hard Vertex.
Point) (p. 1060)
Method Delete() (p. 1060) Run the Delete action.
Method DeleteAllVirtualCells() (p. 1060) Delete all Virtual Cells.
Method DeleteAllVirtualEntities() (p. 1060) Delete all Virtual Entities.
Method DeleteAllVirtualHardVertices() (p. 1061) Delete all Virtual Split Hard Vertices.
Method DeleteAllVirtualSplitEdges() (p. 1061) Delete all Virtual Split Edges.
Method DeleteAllVirtualSplitFaces() (p. 1061) Delete all Virtual Split Faces.
Method GenerateVirtualCells(ISelectionInfo) (p. 1061) Generate the Virtual Cells on the
selected/all entities.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1061)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1062)
Method GetVirtualCellFromSelection(ISelectionInfo) (p. 1062)
Gets the Virtual Cell from the selection.
Method VirtualSplitEdge(ISelectionInfo, double) (p. 1063) Generate the Virtual Cells on the
selected/all entities.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1053
Ansys.ACT.Automation.Mechanical Namespace

Method VirtualSplitFaceAtVertices(ISelectionInfo) (p. 1063) 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; }

CustomFeatureAngle
Gets or sets the CustomFeatureAngle.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1054 of ANSYS, Inc. and its subsidiaries and affiliates.
 VirtualTopology

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; }

Images
Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1055
Ansys.ACT.Automation.Mechanical Namespace

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; }

MergeFaceEdges
Gets or sets the MergeFaceEdges.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1056 of ANSYS, Inc. and its subsidiaries and affiliates.
 VirtualTopology

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; }

SharedBoundaryRatio
Gets or sets the SharedBoundaryRatio.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1057
Ansys.ACT.Automation.Mechanical Namespace

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; }

VirtualSplitEdges
Gets the VirtualSplitEdges.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1058 of ANSYS, Inc. and its subsidiaries and affiliates.
 VirtualTopology

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.

AddVirtualCell(ISelectionInfo)
Add Virtual Cell.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1059
Ansys.ACT.Automation.Mechanical Namespace

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1060 of ANSYS, Inc. and its subsidiaries and affiliates.
 VirtualTopology

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()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1061
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.)

GetVirtualCellFromSelection(ISelectionInfo)
Gets the Virtual Cell from the selection.

Declaration Syntax
public virtual VirtualCell GetVirtualCellFromSelection(ISelectionInfo currentSelection)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1062 of ANSYS, Inc. and its subsidiaries and affiliates.
 VolumeConstraint

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)

Parameters
iSelInfo(ISelectionInfo)

No details are provided for this entry.

VolumeConstraint
Defines a VolumeConstraint.

Declaration Syntax
public class VolumeConstraint : ResponseConstraint

Table 284: Members

Property Children (p. 809) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1063
Ansys.ACT.Automation.Mechanical Namespace

(Inherited from ResponseConstraint (p. 809).)

Property DataModelObjectCategory (p. 1064) Gets the current DataModelObject's category.
Property DefineBy (p. 1064) Gets or sets the DefineBy.
Property EnvironmentSelection (p. 810) Gets or Sets the EnvironmentSelection to an Analysis
object or TopoEnvironmentType enum.

(Inherited from ResponseConstraint (p. 809).)

Property InternalObject (p. 1064)
Property Location (p. 1065)
Property MaximumAbsoluteValue (p. 1065)
Property MinimumAbsoluteValue (p. 1065)
Property PercentageToRetain (p. 1065)
Property PercentageToRetainMax (p. 1065)
Property PercentageToRetainMin (p. 1065)
Property ScopingMethod (p. 1066)
Property Selection (p. 1066)
Property Suppressed (p. 810)
Gets the internal object. For advanced usage only.
Gets or sets the Location.
Gets or sets the MaximumAbsoluteValue.
Gets or sets the MinimumAbsoluteValue.
Gets or sets the PercentageToRetain.
Gets or sets the PercentageToRetainMax.
Gets or sets the PercentageToRetainMin.
Gets or sets the ScopingMethod.
Gets or sets the Selection.
Gets or sets the Suppressed.

(Inherited from ResponseConstraint (p. 809).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1064 of ANSYS, Inc. and its subsidiaries and affiliates.
 VolumeConstraint

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; }

PercentageToRetainMin
Gets or sets the PercentageToRetainMin.

Declaration Syntax
public int PercentageToRetainMin { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1065
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; }

Worksheet
No details are provided for this entry.

Declaration Syntax
public abstract class Worksheet : IWorksheet

ZCrossSection
Defines a ZCrossSection.

Declaration Syntax
public class ZCrossSection : CrossSection

Table 285: Members

Property Area (p. 1067) Gets the Area.

Property Children (p. 323) Gets the list of children.

(Inherited from CrossSection (p. 322).)

Property Comments (p. 323) Gets the list of associated comments.

(Inherited from CrossSection (p. 322).)

Property DataModelObjectCategory (p. 1067)Gets the current DataModelObject's
category.
Property Figures (p. 323) Gets the list of associated figures.

(Inherited from CrossSection (p. 322).)

Property Images (p. 323) Gets the list of associated images.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1066 of ANSYS, Inc. and its subsidiaries and affiliates.
 ZCrossSection

(Inherited from CrossSection (p. 322).)

Property InternalObject (p. 1067) Gets the internal object. For advanced usage
only.
Property IYY (p. 1067) Gets the IYY.
Property IZZ (p. 1068) Gets the IZZ.
Property Thick1 (p. 1068) Gets or sets the Thick1.
Property Thick2 (p. 1068) Gets or sets the Thick2.
Property Thick3 (p. 1068) Gets or sets the Thick3.
Property Width1 (p. 1068) Gets or sets the Width1.
Property Width2 (p. 1068) Gets or sets the Width2.
Property Width3 (p. 1069) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1067
Ansys.ACT.Automation.Mechanical Namespace

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1068 of ANSYS, Inc. and its subsidiaries and affiliates.
 ZCrossSection

Width3
Gets or sets the Width3.

Declaration Syntax
public Quantity Width3 { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1069
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1070 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.FE Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.FE

Table 286: Members

Command (p. 1071) Base class for all

Commands.
CommandColl (p. 1072) Collection of
commands.
CommandRepository (p. 1072) Command repository.
CommandsType (p. 1074) Commands type.
FEParser (p. 1075) FE parser object.

Command
Base class for all Commands.

Declaration Syntax
public class Command : ICommand

Table 287: Members

Property Index (p. 1071) Gets the command

index.
Property Name (p. 1071) Gets the command
name.

Index
Gets the command index.

Declaration Syntax
public uint Index { get; }

Name
Gets the command name.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1071
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 288: Members

Property Count (p. 1072) Gets the count of

commands.
Property Item (p. 1072) 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 289: Members

Method GetCommandByIndex(int) (p. 1073) Gets the commands by index.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1072 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandRepository

Method GetCommandName(CommandsType, int) (p. 1073) Gets the name of commands of a type
specified by params eCommandsType
and index in the repository.
Method GetCommandNames(CommandsType) (p. 1074) Gets the command names of a type
specified by params eCommandsType
and index in the repository.
Method GetCommandNamesCount(CommandsType) (p. 1074)Gets the number of commands of a
type specified by
param=eCommandsType in the
repository.
Method GetCommandsByName(string) (p. 1074) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1073
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1074 of ANSYS, Inc. and its subsidiaries and affiliates.
 FEParser

Declaration Syntax
public enum CommandsType

Table 290: Members

Member All All commands.

Member Processed Unprocessed
commands.
Member UnProcessed Processed
commands.

FEParser
FE parser object.

Declaration Syntax
public class FEParser

Table 291: Members

Constructor FEParser() (p. 1075) Default

constructor.

FEParser()
Default constructor.

Declaration Syntax
public FEParser()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1075
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1076 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 292: Members

CaseControlCommand (p. 1077) Case control

command.
GenericCommand (p. 1078) Generic command.
NastranOption (p. 1078) Option.
NastranOptionLine (p. 1078) Option line.
OptionsControlCommand (p. 1079) Options control
command.

CaseControlCommand
Case control command.

Declaration Syntax
public class CaseControlCommand : NASTRANCommand

Table 293: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Text (p. 1077) Gets the text.

Text
Gets the text.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1077
Ansys.ACT.Automation.Mechanical.FE.NASTRAN Namespace

Declaration Syntax
public string Text { get; }

GenericCommand
Generic command.

Declaration Syntax
public class GenericCommand : NASTRANCommand

Table 294: Members

Property Arguments (p. 1078) Gets the arguments.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1078 of ANSYS, Inc. and its subsidiaries and affiliates.
 OptionsControlCommand

OptionsControlCommand
Options control command.

Declaration Syntax
public class OptionsControlCommand : NASTRANCommand

Table 295: Members

Property Arguments (p. 1079) Gets the arguments.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property OptionLines (p. 1079) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1079
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1080 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 296: Members

BeamSecBlockCommand (p. 1082) Represents a beam SECBLOCK command.

BFBlockCommand (p. 1083) Represents a BFBLOCK command.
BFCommand (p. 1084) Represents a BF command.
BFEBlockCommand (p. 1085) Represents a BFEBLOCK command.
BFECommand (p. 1086) Represents a BFE command.
CECMODCommand (p. 1088) Represents a CECMOD command.
CECommand (p. 1089) Represents a CE command.
CMBlockCommand (p. 1090) Represents a CMBLOCK command.
CMEDITCommand (p. 1091) Represents a CMEDIT command.
CMGRPCommand (p. 1092) Represents a CMGRP command.
CommandCell (p. 1092) Represents cell data associated to a beam SECBLOCK
command.
CommandCETerm (p. 1093) Represents a term associated to a CE command.
CommandElement (p. 1094) Represents an element associated to an EBLOCK
command.
CommandElementBodyForce (p. 1096) Represents element body-force loads associated to
BFEBLOCK command.
CommandElementSurfaceLoad (p. 1097) Represents an element surface load associated to a
SFEBLOCK command.
CommandElementSurfaceLoadValues (p. 1098) Values associated to an element surface load from a
SFEBLOCK command.
CommandKeyOpt (p. 1099) Represents a KEYOPT command.
CommandLayer (p. 1099) Represents a layer associated to a shell SECBLOCK
command.
CommandNodalBodyForce (p. 1100) Represents a nodal body force associated to a
BFBLOCK command.
CommandNode (p. 1101) Represents a node associated to a NBLOCK command.
CommandReal (p. 1102) Represent a real constant set associated to a RLBLOCK
command.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1081
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

CPCommand (p. 1103) Represents a CP command.

EBlockCommand (p. 1104) Represents an EBLOCK command.
ENCommand (p. 1104) Represents an EN command.
ETCommand (p. 1105) Represents an ET command.
GenericCommand (p. 1106) Represents a generic command.
LocalCommand (p. 1106) Represents a LOCAL command.
MPCommand (p. 1108) Represents a MP command.
MPDataCommand (p. 1109) Represents a MPDATA command.
NBlockCommand (p. 1111) Represents a NBLOCK command.
NCommand (p. 1111) Represents a N command.
PreadCommand (p. 1112) Represents a *PREAD command.
RCommand (p. 1113) Represents a R command.
RLBlockCommand (p. 1114) Represents a RLBLOCK command.
SecdataCommand (p. 1115) Represents a SECDATA command.
SecoffsetCommand (p. 1115) Represents a SECOFFSET command.
SectypeCommand (p. 1116) Represents a SECTYPE command.
SFEBlockCommand (p. 1117) Represents a SFEBLOCK command.
SFECommand (p. 1118) Represents a SFE command.
ShellSecBlockCommand (p. 1120) Represents a shell SECBLOCK command.
TBDataCommand (p. 1120) Represents a TBDATA command.
TBDataValues (p. 1122) Represents data for a given temperature.
TBPTCommand (p. 1123) Represents a TBPT command.
TBPTData (p. 1125) Represents data for the TBPT command.
TBPTValues (p. 1125) Represents a tuple of values for the TBPT commmand.

BeamSecBlockCommand
Represents a beam SECBLOCK command.

Declaration Syntax
public class BeamSecBlockCommand : CDBCommand

Table 297: Members

Property Cells (p. 1083) Gets the cells of the section.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1082 of ANSYS, Inc. and its subsidiaries and affiliates.
 BFBlockCommand

(Inherited from
Command (p. 1071).)
Property Nodes (p. 1083) Gets the nodes of the
section.
Property Type (p. 1083) 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.

Declaration Syntax
public class BFBlockCommand : CDBCommand

Table 298: Members

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Lab (p. 1084) Gets the label.
Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1083
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Property NodalBodyForceCount (p. 1084) Gets the number of nodal body-force

loads.
Property NodalBodyForces (p. 1084) 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.

Declaration Syntax
public class BFCommand : CDBCommand

Table 299: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Lab (p. 1085) Gets the label.
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1084 of ANSYS, Inc. and its subsidiaries and affiliates.
 BFEBlockCommand

Property Node (p. 1085) Gets the node number.

Property ValCount (p. 1085) Gets the number of values.
Property Values (p. 1085) 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.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

BFEBlockCommand
Represents a BFEBLOCK command.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1085
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public class BFEBlockCommand : CDBCommand

Table 300: Members

Property ElementBodyForceCount (p. 1086) Gets the number of element body-force

loads.
Property ElementBodyForces (p. 1086) Gets the element body-force loads.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Lab (p. 1086) Gets the label.
Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

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; }

BFECommand
Represents a BFE command.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1086 of ANSYS, Inc. and its subsidiaries and affiliates.
 BFECommand

Declaration Syntax
public class BFECommand : CDBCommand

Table 301: Members

Property Elem (p. 1087) Gets the element number.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Lab (p. 1087) Gets the label.
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Stloc (p. 1087) Gets the starting location.
Property ValCount (p. 1087) Gets the number of values.
Property Values (p. 1088) 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; }

ValCount
Gets the number of values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1087
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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 302: Members

Property Constant (p. 1088) Gets the constant term of the

equation.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Nce (p. 1088) 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.

Declaration Syntax
public uint Nce { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1088 of ANSYS, Inc. and its subsidiaries and affiliates.
 CECommand

CECommand
Represents a CE command.

Declaration Syntax
public class CECommand : CDBCommand

Table 303: Members

Property Constant (p. 1089) Gets the constant term of the

equation.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Nce (p. 1089) Gets the constraint equation
number.
Property Terms (p. 1089) 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.

Declaration Syntax
public IReadOnlyList<CommandCETerm> Terms { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1089
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

CMBlockCommand
Represents a CMBLOCK command.

Declaration Syntax
public class CMBlockCommand : CDBCommand

Table 304: Members

Property Cmname (p. 1090) Gets the component name.

Property Elements (p. 1090) Gets the type of entities.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Type (p. 1090) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1090 of ANSYS, Inc. and its subsidiaries and affiliates.
 CMEDITCommand

CMEDITCommand
Represents a CMEDIT command.

Declaration Syntax
public class CMEDITCommand : CDBCommand

Table 305: Members

Property Aname (p. 1091) Gets the assembly name.

Property Cnames (p. 1091) Gets the component names.
Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Oper (p. 1091) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1091
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

CMGRPCommand
Represents a CMGRP command.

Declaration Syntax
public class CMGRPCommand : CDBCommand

Table 306: Members

Property Aname (p. 1092) Gets the assembly name.

Property Cnames (p. 1092) Gets the component and/or assembly
names.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

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 307: Members

Property MatId (p. 1093) Gets the material

number.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1092 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandCETerm

Property Nodes (p. 1093) 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 308: Members

Property Coefficient (p. 1093) Gets the coefficient.

Property Dof (p. 1093) Gets the degree of
freedom.
Property Node (p. 1094) Gets the node number.

Coefficient
Gets the coefficient.

Declaration Syntax
public double Coefficient { get; }

Dof
Gets the degree of freedom.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1093
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 309: Members

Property Csys (p. 1094) Gets the coordinate system

number.
Property Id (p. 1094) Gets the element number.
Property Mat (p. 1095) Gets the material number.
Property NodeCount (p. 1095) Gets the number of nodes.
Property Nodes (p. 1095) Gets the nodes.
Property Real (p. 1095) Gets the real constant set
number.
Property Section (p. 1095) Gets the section number.
Property Type (p. 1095) Gets the element type number.

Csys
Gets the coordinate system number.

Declaration Syntax
public uint Csys { get; }

Id
Gets the element number.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1094 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandElement

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.

Declaration Syntax
public uint Section { get; }

Type
Gets the element type number.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1095
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public uint Type { get; }

CommandElementBodyForce
Represents element body-force loads associated to BFEBLOCK command.

Declaration Syntax
public class CommandElementBodyForce

Table 310: Members

Property Count (p. 1096) Gets the number of element body-force

loads.
Property Elem (p. 1096) Gets the element number.
Property Stlocs (p. 1096) Gets the starting locations.
Property Values (p. 1096) 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.

Declaration Syntax
public IReadOnlyList<int> Stlocs { get; }

Values
Gets the values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1096 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandElementSurfaceLoad

Declaration Syntax
public IReadOnlyList<object> Values { get; }

CommandElementSurfaceLoad
Represents an element surface load associated to a SFEBLOCK command.

Declaration Syntax
public class CommandElementSurfaceLoad

Table 311: Members

Property Count (p. 1097) Gets the number of element surface

loads.
Property Elem (p. 1097) Gets the element number.
Property ElementSurfaceLoadValues (p. 1097) Gets the values.
Property Keys (p. 1098) Gets the keys.
Property LKeys (p. 1098) 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; }

ElementSurfaceLoadValues
Gets the values.

Declaration Syntax
public IReadOnlyList<CommandElementSurfaceLoadValues> ElementSurfaceLoadValues { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1097
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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 312: Members

Property ValueCount (p. 1098) Gets the number of

values.
Property Values (p. 1098) Gets the values.

ValueCount
Gets the number of values.

Declaration Syntax
public int ValueCount { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<object> Values { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1098 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandLayer

CommandKeyOpt
Represents a KEYOPT command.

Declaration Syntax
public class CommandKeyOpt

Table 313: Members

Property Knum (p. 1099) Gets the key option

number.
Property Value (p. 1099) 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 314: Members

Property Mat (p. 1100) Gets the material number.

Property Numpt (p. 1100) Gets the number of integration points in the
layer.
Property Theta (p. 1100) Gets the layer orientation angle.
Property Thick (p. 1100) Gets the thickness.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1099
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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 315: Members

Property Node (p. 1101) Gets the node

number.
Property ValCount (p. 1101) Gets the number of
values.
Property Values (p. 1101) Gets the values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1100 of ANSYS, Inc. and its subsidiaries and affiliates.
 CommandNode

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; }

CommandNode
Represents a node associated to a NBLOCK command.

Declaration Syntax
public class CommandNode

Table 316: Members

Property Id (p. 1101) Gets the node

number.
Property Location (p. 1102) Gets the
coordinates.
Property Rotation (p. 1102) Gets the rotation
angles.

Id
Gets the node number.

Declaration Syntax
public uint Id { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1101
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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 317: Members

Property Id (p. 1102) Gets the real constant set

number.
Property Values (p. 1102) Gets the values.

Id
Gets the real constant set number.

Declaration Syntax
public uint Id { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1102 of ANSYS, Inc. and its subsidiaries and affiliates.
 CPCommand

CPCommand
Represents a CP command.

Declaration Syntax
public class CPCommand : CDBCommand

Table 318: Members

Property Dof (p. 1103) Gets the degree of freedom

label.
Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Ncp (p. 1103) Gets the number of coupled
nodes.
Property Nodes (p. 1103) 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.

Declaration Syntax
public IReadOnlyList<int> Nodes { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1103
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

EBlockCommand
Represents an EBLOCK command.

Declaration Syntax
public class EBlockCommand : CDBCommand

Table 319: Members

Property Elements (p. 1104) Gets the elements.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)

Elements
Gets the elements.

Declaration Syntax
public IReadOnlyList<CommandElement> Elements { get; }

ENCommand
Represents an EN command.

Declaration Syntax
public class ENCommand : CDBCommand

Table 320: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Type (p. 1105) Gets the type (attribute or
node).
Property Values (p. 1105) Gets the values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1104 of ANSYS, Inc. and its subsidiaries and affiliates.
 ETCommand

Type
Gets the type (attribute or node).

Declaration Syntax
public string Type { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<int> Values { get; }

ETCommand
Represents an ET command.

Declaration Syntax
public class ETCommand : CDBCommand

Table 321: Members

Property Ename (p. 1105) Gets the element name.

Property Id (p. 1106) Gets the element number.
Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Keyopts (p. 1106) Gets the key options.
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)

Ename
Gets the element name.

Declaration Syntax
public uint Ename { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1105
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Id
Gets the element number.

Declaration Syntax
public uint Id { get; }

Keyopts
Gets the key options.

Declaration Syntax
public IReadOnlyList<CommandKeyOpt> Keyopts { get; }

GenericCommand
Represents a generic command.

Declaration Syntax
public class GenericCommand : CDBCommand

Table 322: Members

Property Arguments (p. 1106) Gets the arguments.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)

Arguments
Gets the arguments.

Declaration Syntax
public IReadOnlyList<string> Arguments { get; }

LocalCommand
Represents a LOCAL command.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1106 of ANSYS, Inc. and its subsidiaries and affiliates.
 LocalCommand

Declaration Syntax
public class LocalCommand : CDBCommand

Table 323: Members

Property Cstyp (p. 1107) Gets the system type.

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Ncsy (p. 1107) Gets the system number.
Property Type (p. 1107) Gets the type of the data to be
defined.
Property Values (p. 1107) Gets the values.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1107
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public IReadOnlyList<double> Values { get; }

MPCommand
Represents a MP command.

Declaration Syntax
public class MPCommand : CDBCommand

Table 324: Members

Property C0 (p. 1108) Gets the temperature-independent term of the property.

Property C1 (p. 1108) Gets the coefficient of the linear term in the property-versus-temperature
polynomial.
Property C2 (p. 1109) Gets the coefficient of the quadratic term in the property-versus-temperature
polynomial.
Property C3 (p. 1109) Gets the coefficient of the cubic term in the property-versus-temperature
polynomial.
Property C4 (p. 1109) Gets the coefficient of the quartic term in the property-versus-temperature
polynomial.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Lab (p. 1109) Gets the label.
Property Mat (p. 1109) Gets the material number.
Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1108 of ANSYS, Inc. and its subsidiaries and affiliates.
 MPDataCommand

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1109
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public class MPDataCommand : CDBCommand

Table 325: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Lab (p. 1110) Gets the label.
Property Mat (p. 1110) Gets the material number.
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Temps (p. 1110) Gets the temperatures.
Property Values (p. 1110) Gets the values.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1110 of ANSYS, Inc. and its subsidiaries and affiliates.
 NCommand

Declaration Syntax
public IReadOnlyList<double> Values { get; }

NBlockCommand
Represents a NBLOCK command.

Declaration Syntax
public class NBlockCommand : CDBCommand

Table 326: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Nodes (p. 1111) 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 327: Members

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1111
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Property Node (p. 1112) Gets the node number.

Property Type (p. 1112) Gets the type of the data to be
defined.
Property Values (p. 1112) Gets the values.

Node
Gets the node number.

Declaration Syntax
public uint Node { 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; }

PreadCommand
Represents a *PREAD command.

Declaration Syntax
public class PreadCommand : CDBCommand

Table 328: Members

Property Aname (p. 1113) Gets the table name.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1112 of ANSYS, Inc. and its subsidiaries and affiliates.
 RCommand

(Inherited from
Command (p. 1071).)
Property Values (p. 1113) 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; }

RCommand
Represents a R command.

Declaration Syntax
public class RCommand : CDBCommand

Table 329: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Nset (p. 1113) Gets the set number.
Property Stloc (p. 1114) Gets the starting location.
Property Values (p. 1114) Gets the values.

Nset
Gets the set number.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1113
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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; }

RLBlockCommand
Represents a RLBLOCK command.

Declaration Syntax
public class RLBlockCommand : CDBCommand

Table 330: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Reals (p. 1114) Gets the real constant sets.

Reals
Gets the real constant sets.

Declaration Syntax
public IReadOnlyList<CommandReal> Reals { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1114 of ANSYS, Inc. and its subsidiaries and affiliates.
 SecoffsetCommand

SecdataCommand
Represents a SECDATA command.

Declaration Syntax
public class SecdataCommand : CDBCommand

Table 331: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Values (p. 1115) 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 332: Members

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Location (p. 1116) Gets the location of nodes in the
section.
Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Values (p. 1116) Gets the values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1115
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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 333: Members

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property RefineKey (p. 1116) Mesh refinement level for thin-walled beam sections. Default is zero.
Meaningless if type is not BEAM.
Property Secid (p. 1117) Gets the section type number.
Property Secname (p. 1117) Gets the section name.
Property Subtype (p. 1117) Gets the subtype.
Property Type (p. 1117) Get the type.

RefineKey
Mesh refinement level for thin-walled beam sections. Default is zero. Meaningless if type is not BEAM.

Declaration Syntax
public int RefineKey { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1116 of ANSYS, Inc. and its subsidiaries and affiliates.
 SFEBlockCommand

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.

Declaration Syntax
public class SFEBlockCommand : CDBCommand

Table 334: Members

Property ElementSurfaceLoadCount (p. 1118)Gets the number of element surface

loads.
Property ElementSurfaceLoads (p. 1118) Get the element surface loads.
Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1117
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Property Lab (p. 1118) Gets the surface load label.

Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

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.

Declaration Syntax
public class SFECommand : CDBCommand

Table 335: Members

Property Elem (p. 1119) Gets the element number.

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Key (p. 1119) Gets the value key.
Property Lab (p. 1119) Gets the load label.
Property LKey (p. 1119) Get the load key.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1118 of ANSYS, Inc. and its subsidiaries and affiliates.
 SFECommand

Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Values (p. 1119) 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.

Declaration Syntax
public uint LKey { get; }

Values
Gets the values.

Declaration Syntax
public IReadOnlyList<double> Values { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1119
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

ShellSecBlockCommand
Represents a shell SECBLOCK command.

Declaration Syntax
public class ShellSecBlockCommand : CDBCommand

Table 336: Members

Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Layers (p. 1120) Gets the layers.
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)
Property Type (p. 1120) 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; }

TBDataCommand
Represents a TBDATA command.

Declaration Syntax
public class TBDataCommand : CDBCommand

Table 337: Members

Property DataValueCount (p. 1121) Gets the number of data values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1120 of ANSYS, Inc. and its subsidiaries and affiliates.
 TBDataCommand

Property DataValues (p. 1121) Gets the data values.

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Lab (p. 1121) Gets the label.
Property Mat (p. 1121) Gets the material number.
Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Npts (p. 1122) Gets the number of points, if provided.
Property Ntemp (p. 1122) Gets the number of temperature, if
provided.
Property Tbopt (p. 1122) 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.

Declaration Syntax
public string Lab { get; }

Mat
Gets the material number.

Declaration Syntax
public int Mat { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1121
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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 338: Members

Property Temp (p. 1122) Gets the temperature.

Property ValueCount (p. 1123) Gets the number of
values.
Property Values (p. 1123) Gets the values.

Temp
Gets the temperature.

Declaration Syntax
public double Temp { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1122 of ANSYS, Inc. and its subsidiaries and affiliates.
 TBPTCommand

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 339: Members

Property Index (p. 1071) Gets the command index.

(Inherited from Command (p. 1071).)

Property Lab (p. 1123) Gets the label.
Property Mat (p. 1124) Gets the material number.
Property Name (p. 1071) Gets the command name.

(Inherited from Command (p. 1071).)

Property Npts (p. 1124) Gets the number of points, if provided.
Property Ntemp (p. 1124) Gets the number of temperature, if
provided.
Property Tbopt (p. 1124) Gets the option.
Property TBPTData (p. 1124) Gets TBPT data items.
Property TBPTDataCount (p. 1124) Gets the number of TBPT data.

Lab
Gets the label.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1123
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

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; }

TBPTData
Gets TBPT data items.

Declaration Syntax
public IReadOnlyList<TBPTData> TBPTData { get; }

TBPTDataCount
Gets the number of TBPT data.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1124 of ANSYS, Inc. and its subsidiaries and affiliates.
 TBPTValues

Declaration Syntax
public int TBPTDataCount { get; }

TBPTData
Represents data for the TBPT command.

Declaration Syntax
public class TBPTData

Table 340: Members

Property TBPTCount (p. 1125) Gets the number of

values.
Property TBPTValues (p. 1125) Gets the TBPT values.
Property Temp (p. 1125) 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; }

Temp
Gets the temperature.

Declaration Syntax
public double Temp { get; }

TBPTValues
Represents a tuple of values for the TBPT commmand.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1125
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace

Declaration Syntax
public class TBPTValues

Table 341: Members

Property ValueCount (p. 1126) Gets the number of

values.
Property Values (p. 1126) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1126 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 342: Members

AbaqusKeyword (p. 1127) Represents an Abaqus keyword (with arguments and data
lines).
AbaqusKeywordArgument (p. 1128) Represents a keyword argument (with Key and Value).
AbaqusKeywordArgumentColl (p. 1128) Collection of keyword arguments.
AbaqusKeywordDataLine (p. 1129) Represents a keyword data line.
AbaqusKeywordDataLineColl (p. 1129) Collection of keyword data lines.

AbaqusKeyword
Represents an Abaqus keyword (with arguments and data lines).

Declaration Syntax
public class AbaqusKeyword : ABAQUSCommand

Table 343: Members

Property Arguments (p. 1127) Gets the arguments.

Property DataLines (p. 1128) Gets the data lines.
Property Index (p. 1071) Gets the command index.

(Inherited from
Command (p. 1071).)
Property Name (p. 1071) Gets the command name.

(Inherited from
Command (p. 1071).)

Arguments
Gets the arguments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1127
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 344: Members

Property Key (p. 1128) Gets the

Key.
Property Value (p. 1128) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1128 of ANSYS, Inc. and its subsidiaries and affiliates.
 AbaqusKeywordDataLineColl

Declaration Syntax
public class AbaqusKeywordArgumentColl

Table 345: Members

Property Items (p. 1129) 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 346: Members

Property Items (p. 1129) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1129
Ansys.ACT.Automation.Mechanical.FE.ABAQUS Namespace

Declaration Syntax
public class AbaqusKeywordDataLineColl

Table 347: Members

Property Items (p. 1130) Gets the list of data

lines.

Items
Gets the list of data lines.

Declaration Syntax
public IReadOnlyList<AbaqusKeywordDataLine> Items { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1130 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results

Table 348: Members

Alert (p. 1132) Defines a Alert.

ContactDataTable (p. 1135) Defines a ContactDataTable.
Convergence (p. 1138) Defines a Convergence.
LatticeDensity (p. 1142) Defines a LatticeDensity.
LatticeElementalDensity (p. 1144) Defines a LatticeElementalDensity.
LinePressureResult (p. 1147) Defines a LinePressureResult.
MagneticCoenergy (p. 1151) Defines a MagneticCoenergy.
MagneticPotential (p. 1155) Defines a MagneticPotential.
NewtonRaphsonResidualCharge (p. 1158) Defines a
NewtonRaphsonResidualCharge.
NewtonRaphsonResidualForce (p. 1162) Defines a
NewtonRaphsonResidualForce.
NewtonRaphsonResidualHeat (p. 1166) Defines a
NewtonRaphsonResidualHeat.
NewtonRaphsonResidualMoment (p. 1170) Defines a
NewtonRaphsonResidualMoment.
Result (p. 1174) Defines a Result.
ResultChart (p. 1188) Defines a ResultChart.
ResultTable (p. 1200) Defines a ResultTable.
ShapeFinder (p. 1203) Defines a ShapeFinder.
ShapeFinderElemental (p. 1207) Defines a ShapeFinderElemental.
Smoothing (p. 1211) Defines a Smoothing.
TopologyDensity (p. 1213) Defines a TopologyDensity.
TopologyElementalDensity (p. 1216) Defines a TopologyElementalDensity.
TopologyOptimizationResult (p. 1218) Defines a
TopologyOptimizationResult.
UserDefinedResult (p. 1226) Defines a UserDefinedResult.
VariableGraph (p. 1241) Defines a VariableGraph.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1131
Ansys.ACT.Automation.Mechanical.Results Namespace

Volume (p. 1244) Defines a Volume.

Alert
Defines a Alert.

Declaration Syntax
public class Alert : DataModelObject, IFolderDataModelObject

Table 349: Members

Property Children (p. 1132) Gets the list of children.

Property Comments (p. 1132) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1133) Gets the current DataModelObject's category.
Property FailsIf (p. 1133) Gets or sets the FailsIf.
Property Images (p. 1133) Gets the list of associated images.
Property InternalObject (p. 1133) Gets the internal object. For advanced usage only.
Property Status (p. 1133) Gets the Status.
Property Value (p. 1133) Gets or sets the Value.
Method AddComment() (p. 1134) Creates a new child Comment.
Method AddImage(string) (p. 1134) 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. 1134) Run the Delete action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1134)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1135)

Children
Gets the list of children.

Declaration Syntax
public IList<IDataModelObject> Children { get; }

Comments
Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1132 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1133
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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1134 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 350: Members

Property Children (p. 1136) Gets the list of children.

Property Comments (p. 1136) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1136) Gets the current DataModelObject's
category.
Property Figures (p. 1136) Gets the list of associated figures.
Property InternalObject (p. 1136) Gets the internal object. For advanced usage
only.
Method AddComment() (p. 1137) Creates a new child Comment.
Method AddFigure() (p. 1137) Creates a new child Figure.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1135
Ansys.ACT.Automation.Mechanical.Results Namespace

Method Delete() (p. 1137) Run the Delete action.

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1137)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1137)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1136 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()

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1137
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.)

Convergence
Defines a Convergence.

Declaration Syntax
public class Convergence : DataModelObject, IFolderDataModelObject

Table 351: Members

Property AllowableChange (p. 1139) Gets or sets the AllowableChange.

Property Children (p. 1139) Gets the list of children.
Property Comments (p. 1139) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1139) Gets the current DataModelObject's category.
Property Figures (p. 1139) Gets the list of associated figures.
Property Images (p. 1140) Gets the list of associated images.
Property InternalObject (p. 1140) Gets the internal object. For advanced usage only.
Property IsConverged (p. 1140) Gets the IsConverged.
Property LastChange (p. 1140) Gets the LastChange.
Property Type (p. 1140) Gets or sets the Type.
Method AddComment() (p. 1140) Creates a new child Comment.
Method AddFigure() (p. 1141) Creates a new child Figure.
Method AddImage(string) (p. 1141) 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. 1141) Run the Delete action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1138 of ANSYS, Inc. and its subsidiaries and affiliates.
 Convergence

Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.

IList<ChildrenType>) (p. 1141)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1142)

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.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1139
Ansys.ACT.Automation.Mechanical.Results 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 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.

Declaration Syntax
public ConvergenceType Type { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1140 of ANSYS, Inc. and its subsidiaries and affiliates.
 Convergence

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1141
Ansys.ACT.Automation.Mechanical.Results 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.)

LatticeDensity
Defines a LatticeDensity.

Declaration Syntax
public class LatticeDensity : TopologyOptimizationResult

Table 352: Members

Property CalculateTimeHistory (p. 1220) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Children (p. 1220) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Comments (p. 1220) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1142 of ANSYS, Inc. and its subsidiaries and affiliates.
 LatticeDensity

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property DataModelObjectCategory (p. 1144)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1220) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Figures (p. 1220) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalMass (p. 1221) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalVolume (p. 1221) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Images (p. 1221) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property InternalObject (p. 1144) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1221) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property IterationStep (p. 1221) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Location (p. 1222) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Maximum (p. 1222) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Minimum (p. 1222) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalMass (p. 1222) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1143
Ansys.ACT.Automation.Mechanical.Results Namespace

Property OriginalVolume (p. 1222) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentMassOfOriginal (p. 1222) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentVolumeOfOriginal (p. 1223) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property ScopingMethod (p. 1223) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Selection (p. 1223) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property ShowOptimizedRegion (p. 1223) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Suppressed (p. 1223) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1218).)

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; }

LatticeElementalDensity
Defines a LatticeElementalDensity.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1144 of ANSYS, Inc. and its subsidiaries and affiliates.
 LatticeElementalDensity

Declaration Syntax
public class LatticeElementalDensity : TopologyOptimizationResult

Table 353: Members

Property CalculateTimeHistory (p. 1220) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Children (p. 1220) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Comments (p. 1220) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property DataModelObjectCategory (p. 1146)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1220) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Figures (p. 1220) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalMass (p. 1221) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalVolume (p. 1221) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Images (p. 1221) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property InternalObject (p. 1147) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1221) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property IterationStep (p. 1221) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1218).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1145
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Location (p. 1222) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Maximum (p. 1222) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Minimum (p. 1222) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalMass (p. 1222) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalVolume (p. 1222) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentMassOfOriginal (p. 1222) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentVolumeOfOriginal (p. 1223) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property ScopingMethod (p. 1223) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Selection (p. 1223) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property ShowOptimizedRegion (p. 1223) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Suppressed (p. 1223) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1218).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1146 of ANSYS, Inc. and its subsidiaries and affiliates.
 LinePressureResult

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 354: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1147
Ansys.ACT.Automation.Mechanical.Results Namespace

Property DataModelObjectCategory (p. 1150) Gets the current DataModelObject's

category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1150) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LinePressureResultBasedOn (p. 1151) Gets or sets the
LinePressureResultBasedOn.
Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1148 of ANSYS, Inc. and its subsidiaries and affiliates.
 LinePressureResult

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1149
Ansys.ACT.Automation.Mechanical.Results Namespace

Property SolutionCombinationDriver (p. 1182) Gets or sets the

SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1150 of ANSYS, Inc. and its subsidiaries and affiliates.
 MagneticCoenergy

Declaration Syntax
public IDSResultAuto InternalObject { get; }

LinePressureResultBasedOn
Gets or sets the LinePressureResultBasedOn.

Declaration Syntax
public LinePressureResultBasedOnType LinePressureResultBasedOn { set;get; }

MagneticCoenergy
Defines a MagneticCoenergy.

Declaration Syntax
public class MagneticCoenergy : Result

Table 355: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1151
Ansys.ACT.Automation.Mechanical.Results Namespace

Property DataModelObjectCategory (p. 1154) Gets the current DataModelObject's

category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1154) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1152 of ANSYS, Inc. and its subsidiaries and affiliates.
 MagneticCoenergy

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1153
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1154 of ANSYS, Inc. and its subsidiaries and affiliates.
 MagneticPotential

MagneticPotential
Defines a MagneticPotential.

Declaration Syntax
public class MagneticPotential : Result

Table 356: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1158) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1155
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1158) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1156 of ANSYS, Inc. and its subsidiaries and affiliates.
 MagneticPotential

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1157
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

NewtonRaphsonResidualCharge
Defines a NewtonRaphsonResidualCharge.

Declaration Syntax
public class NewtonRaphsonResidualCharge : Result

Table 357: Members

Property Average (p. 1176) Gets the Average.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1158 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualCharge

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1162) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1159
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1162) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1160 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualCharge

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1161
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 358: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1162 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualForce

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1166) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1166) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1163
Ansys.ACT.Automation.Mechanical.Results Namespace

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1164 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualForce

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1165
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; }

NewtonRaphsonResidualHeat
Defines a NewtonRaphsonResidualHeat.

Declaration Syntax
public class NewtonRaphsonResidualHeat : Result

Table 359: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) Gets or sets the Coordinate System.
Accepts/Returns None for Solution
Coordinate System in the general case (if

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1166 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualHeat

applicable). Accepts/Returns None for

Fiber Coordinate System for a result that
is sub scoped by ply.

(Inherited from Result (p. 1174).)

Property DataModelObjectCategory (p. 1169) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1170) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1167
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1168 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualHeat

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1169
Ansys.ACT.Automation.Mechanical.Results Namespace

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 360: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1173) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1170 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualMoment

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1173) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1171
Ansys.ACT.Automation.Mechanical.Results Namespace

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1172 of ANSYS, Inc. and its subsidiaries and affiliates.
 NewtonRaphsonResidualMoment

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1173
Ansys.ACT.Automation.Mechanical.Results Namespace

Result
Defines a Result.

Declaration Syntax
public abstract class Result : DataModelObject, IFolderDataModelObject

Table 361: Members

Property Average (p. 1176) Gets the Average.

Property By (p. 1176) Gets or sets the By.
Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.
Property Children (p. 1176) Gets the list of children.
Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.
Property Comments (p. 1177) Gets the list of associated comments.
Property CoordinateSystem (p. 1177) 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 DataModelObjectCategory (p. 1177) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.
Property DisplayTime (p. 1178) Gets or sets the DisplayTime.
Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.
Property Figures (p. 1178) Gets the list of associated figures.
Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.
Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.
Property Identifier (p. 1178) Gets or sets the Identifier.
Property Images (p. 1179) Gets the list of associated images.
Property InternalObject (p. 1179) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.
Property ItemType (p. 1179) Gets or sets the ItemType.
Property IterationNumber (p. 1179) Gets the IterationNumber.
Property LoadStep (p. 1179) Gets the LoadStep.
Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.
Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1174 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.
Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.
Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.
Property Location (p. 1180) Gets or sets the Location.
Property Maximum (p. 1181) Gets the Maximum.
Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.
Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.
Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.
Property Minimum (p. 1181) Gets the Minimum.
Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.
Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.
Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.
Property PlotData (p. 1182) Gets the result table.
Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.
Property SetNumber (p. 1182) Gets or sets the Set Number.
Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.
Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.
Property Substep (p. 1183) Gets the Substep.
Property Suppressed (p. 1183) Gets or sets the Suppressed.
Property Surface (p. 1183) No details are provided for this entry.
Property Time (p. 1183) Gets the Time.
Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.
Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.
Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.
Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.
Method AddAlert() (p. 1184) Creates a new Alert
Method AddComment() (p. 1184) Creates a new child Comment.
Method AddConvergence() (p. 1184) Creates a new Convergence
Method AddFigure() (p. 1185) Creates a new child Figure.
Method AddImage(string) (p. 1185) 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. 1185) Run the ClearGeneratedData action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1175
Ansys.ACT.Automation.Mechanical.Results Namespace

Method CreateResultsAtAllSets() (p. 1185) Creates results at all sets for results under
a solution.
Method Delete() (p. 1185) Run the Delete action.
Method DuplicateWithoutResults() (p. 1186) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 1186) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1186)
Method ExportToTextFile(string) (p. 1186) Run the ExportToTextFile action.
Method FetchRemoteResults() (p. 1187) Run the FetchRemoteResult action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1187)
Method GetChildren(DataModelObjectCategory, bool, Gets the list of children, filtered by type.
IList<IDataModelObject>) (p. 1187)
Method PromoteToNamedSelection() (p. 1188) Run the PromoteToNamedSelection
action.
Method RenameBasedOnDefinition() (p. 1188) 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.

Declaration Syntax
public bool CalculateTimeHistory { set;get; }

Children
Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1176 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1177
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1178 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

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; }

IterationNumber
Gets the IterationNumber.

Declaration Syntax
public int IterationNumber { get; }

LoadStep
Gets the LoadStep.

Declaration Syntax
public int LoadStep { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1179
Ansys.ACT.Automation.Mechanical.Results Namespace

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1180 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

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; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumOccursOn
Gets the MinimumOccursOn.

Declaration Syntax
public string MinimumOccursOn { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1181
Ansys.ACT.Automation.Mechanical.Results Namespace

MinimumOfMaximumOverTime
Gets the MinimumOfMaximumOverTime.

Declaration Syntax
public Quantity MinimumOfMaximumOverTime { get; }

MinimumOfMinimumOverTime
Gets the MinimumOfMinimumOverTime.

Declaration Syntax
public Quantity MinimumOfMinimumOverTime { get; }

PlotData
Gets the result table.

Declaration Syntax
public ResultDataTable PlotData { 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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1182 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

SolverComponentIDs
Gets or sets the SolverComponentIDs.

Declaration Syntax
public string SolverComponentIDs { 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; }

Surface
No details are provided for this entry.

Declaration Syntax
public Surface Surface { 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1183
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; }

AddAlert()
Creates a new Alert

Declaration Syntax
public virtual Alert AddAlert()

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

AddConvergence()
Creates a new Convergence

Declaration Syntax
public virtual Convergence AddConvergence()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1184 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

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()

Delete()
Run the Delete action.

Declaration Syntax
public virtual void Delete()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1185
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

ExportToTextFile(string)
Run the ExportToTextFile action.

Declaration Syntax
public virtual void ExportToTextFile(string filePath)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1186 of ANSYS, Inc. and its subsidiaries and affiliates.
 Result

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1187
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.)

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 362: Members

Property AccelerationType (p. 1190) Gets or sets the AccelerationType.

Property BoundaryCondition (p. 1190) Gets or sets the BoundaryCondition.
Property ChartDimensions (p. 1190) Gets or sets the Chart Dimensions
Property ChartViewingStyle (p. 1190) Gets or sets the ChartViewingStyle.
Property Children (p. 1191) Gets the list of children.
Property Comments (p. 1191) Gets the list of associated comments.
Property CoordinateSystem (p. 1191) Gets or sets the CoordinateSystem.
Property CurvesAppearanceDisplay (p. 1191) Gets or sets the CurvesAppearanceDisplay.
Property CutFrequency (p. 1191) Gets or sets the CutFrequency.
Property DataModelObjectCategory (p. 1191) Gets the current DataModelObject's category.
Property DeformationType (p. 1192) Gets or sets the DeformationType.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1188 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultChart

Property DpfEvaluation (p. 1192) Gets or sets the DpfEvaluation.

Property Duration (p. 1192) Gets or sets the Duration.
Property EnhancedTracking (p. 1192) Gets the EnhancedTracking.
Property FilterMaximum (p. 1192) Gets the FilterMaximum.
Property FilterMinimum (p. 1192) Gets the FilterMinimum.
Property FilterType (p. 1193) Gets or sets the FilterType.
Property FrequencyAtMaximumAmplitude (p. 1193)Gets the FrequencyAtMaximumAmplitude.
Property GeometrySelectionString (p. 1193) Gets or sets the GeometrySelectionString.
Property Images (p. 1193) Gets the list of associated images.
Property ImaginaryAtMaximumAmplitude (p. 1193)Gets the ImaginaryAtMaximumAmplitude.
Property InternalObject (p. 1193) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1194) Gets the IsSolved.
Property LoadStepNumber (p. 1194) Gets or sets the LoadStepNumber.
Property Location (p. 1194) Gets or sets the Location.
Property Maximum (p. 1194) Gets the Maximum.
Property MaximumAmplitude (p. 1194) Gets the MaximumAmplitude.
Property MaximumFrequency (p. 1194) Gets or sets the MaximumFrequency.
Property Minimum (p. 1195) Gets the Minimum.
Property MinimumFrequency (p. 1195) Gets or sets the MinimumFrequency.
Property NormalOrientation (p. 1195) Gets or sets the NormalOrientation.
Property PhaseAngle (p. 1195) Gets the PhaseAngle.
Property RealAtMaximumAmplitude (p. 1195) Gets the RealAtMaximumAmplitude.
Property ReportedFrequency (p. 1195) Gets the ReportedFrequency.
Property RequestedFrequency (p. 1196) Gets or sets the RequestedFrequency.
Property ResultChartType (p. 1196) Gets the ResultChartType.
Property SectorNumber (p. 1196) Gets or sets the SectorNumber.
Property ShearOrientation (p. 1196) Gets or sets the ShearOrientation.
Property SpatialResolution (p. 1196) Gets or sets the SpatialResolution.
Property Spring (p. 1196) Gets or sets the Spring.
Property StressStrainType (p. 1197) Gets or sets the StressStrainType.
Property Suppressed (p. 1197) Gets or sets the Suppressed.
Property TimeHistoryDisplay (p. 1197) Gets or sets the TimeHistoryDisplay.
Property UseParentFrequencyRange (p. 1197) Gets or sets the UseParentFrequencyRange.
Property VelocityType (p. 1197) Gets or sets the VelocityType.
Property XAxisValues (p. 1197) Gets or sets the XAxisValues.
Method AddComment() (p. 1198) Creates a new child Comment.
Method AddImage(string) (p. 1198) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1189
Ansys.ACT.Automation.Mechanical.Results Namespace

image will be a screen capture of the Geometry

window.
Method ClearGeneratedData() (p. 1198) Run the ClearGeneratedData action.
Method Delete() (p. 1198) Run the Delete action.
Method EvaluateAllResults() (p. 1198) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1199)
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1199)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1199)
Method RenameBasedOnDefinition() (p. 1200) 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

Declaration Syntax
public ChartDimensions ChartDimensions { set;get; }

ChartViewingStyle
Gets or sets the ChartViewingStyle.

Declaration Syntax
public ChartAxisScaleType ChartViewingStyle { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1190 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultChart

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.

Declaration Syntax
public double CutFrequency { set;get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1191
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

Declaration Syntax
public Quantity FilterMaximum { get; }

FilterMinimum
Gets the FilterMinimum.

Declaration Syntax
public Quantity FilterMinimum { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1192 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultChart

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.

Declaration Syntax
public Quantity ImaginaryAtMaximumAmplitude { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1193
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

Declaration Syntax
public Quantity MaximumAmplitude { get; }

MaximumFrequency
Gets or sets the MaximumFrequency.

Declaration Syntax
public Quantity MaximumFrequency { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1194 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultChart

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumFrequency
Gets or sets the MinimumFrequency.

Declaration Syntax
public Quantity MinimumFrequency { set;get; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

PhaseAngle
Gets the PhaseAngle.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1195
Ansys.ACT.Automation.Mechanical.Results Namespace

RequestedFrequency
Gets or sets the RequestedFrequency.

Declaration Syntax
public Quantity RequestedFrequency { set;get; }

ResultChartType
Gets the ResultChartType.

Declaration Syntax
public ChartResultType ResultChartType { get; }

SectorNumber
Gets or sets the SectorNumber.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1196 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultChart

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.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1197
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

Declaration Syntax
public virtual void Delete()

EvaluateAllResults()
Run the EvaluateAllResults action.

Declaration Syntax
public virtual void EvaluateAllResults()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1198 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultChart

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1199
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.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

ResultTable
Defines a ResultTable.

Declaration Syntax
public class ResultTable : DataModelObject, IFolderDataModelObject

Table 363: Members

Property Children (p. 1201) Gets the list of children.

Property Comments (p. 1201) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1201) Gets the current DataModelObject's category.
Property Images (p. 1201) Gets the list of associated images.
Property InternalObject (p. 1201) Gets the internal object. For advanced usage only.
Property Multiplier (p. 1202) Gets or sets the Multiplier.
Method AddComment() (p. 1202) Creates a new child Comment.
Method AddImage(string) (p. 1202) Creates a new child Image. If a filePath is provided,
the image will be loaded from that file, if not, the

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1200 of ANSYS, Inc. and its subsidiaries and affiliates.
 ResultTable

image will be a screen capture of the Geometry

window.
Method Delete() (p. 1202) Run the Delete action.
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)

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 IDSResultTableAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1201
Ansys.ACT.Automation.Mechanical.Results Namespace

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)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1202 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShapeFinder

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.)

ShapeFinder
Defines a ShapeFinder.

Declaration Syntax
public class ShapeFinder : Result

Table 364: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1203
Ansys.ACT.Automation.Mechanical.Results Namespace

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1207) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1207) Gets the internal object. For advanced
usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1204 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShapeFinder

Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1205
Ansys.ACT.Automation.Mechanical.Results Namespace

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1206 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShapeFinderElemental

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 365: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1207
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1210) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1211) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1208 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShapeFinderElemental

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1209
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1210 of ANSYS, Inc. and its subsidiaries and affiliates.
 Smoothing

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 366: Members

Property Children (p. 449) Gets the list of children.

(Inherited from
GeometryFileContainer (p. 448).)
Property Comments (p. 449) Gets the list of associated comments.

(Inherited from
GeometryFileContainer (p. 448).)
Property DataModelObjectCategory (p. 1212)Gets the current DataModelObject's
category.
Property ExportModel (p. 1212) Gets or sets the ExportModel.
Property Figures (p. 449) Gets the list of associated figures.

(Inherited from
GeometryFileContainer (p. 448).)
Property FileName (p. 1212) Gets the FileName.
Property Images (p. 449) Gets the list of associated images.

(Inherited from
GeometryFileContainer (p. 448).)
Property InternalObject (p. 1212) Gets the internal object. For advanced usage
only.
Property LengthUnits (p. 450) Gets or sets the LengthUnits.

(Inherited from
GeometryFileContainer (p. 448).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1211
Ansys.ACT.Automation.Mechanical.Results Namespace

Property MoveLimit (p. 1213) Gets or sets the MoveLimit.

Property ShowAlways (p. 450) Gets or sets the ShowAlways.

(Inherited from
GeometryFileContainer (p. 448).)
Property Statistics (p. 450) Gets the Statistics.

(Inherited from
GeometryFileContainer (p. 448).)
Property Suppressed (p. 450) Gets or sets the Suppressed.

(Inherited from
GeometryFileContainer (p. 448).)
Method Evaluate() (p. 1213) 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.

Declaration Syntax
public string FileName { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSGeometryFileContainerAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1212 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyDensity

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 367: Members

Property CalculateTimeHistory (p. 1220) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Children (p. 1220) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Comments (p. 1220) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property DataModelObjectCategory (p. 1215)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1220) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Figures (p. 1220) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalMass (p. 1221) Gets the FinalMass.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1213
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalVolume (p. 1221) Gets the FinalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Images (p. 1221) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property InternalObject (p. 1215) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1221) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property IterationStep (p. 1221) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Location (p. 1222) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Maximum (p. 1222) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Minimum (p. 1222) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalMass (p. 1222) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalVolume (p. 1222) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentMassOfOriginal (p. 1222) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentVolumeOfOriginal (p. 1223) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property RetainedThreshold (p. 1215) Gets or sets the RetainedThreshold.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1214 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyDensity

Property ScopingMethod (p. 1223) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Selection (p. 1223) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property ShowOptimizedRegion (p. 1223) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Suppressed (p. 1223) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Method AddSmoothing() (p. 1215) Creates a new Smoothing
Method InsertSmoothing() (p. 1216) Run the InsertSmoothing action.

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; }

AddSmoothing()
Creates a new Smoothing

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1215
Ansys.ACT.Automation.Mechanical.Results Namespace

Declaration Syntax
public virtual Smoothing AddSmoothing()

InsertSmoothing()
Run the InsertSmoothing action.

Declaration Syntax
public virtual void InsertSmoothing()

TopologyElementalDensity
Defines a TopologyElementalDensity.

Declaration Syntax
public class TopologyElementalDensity : TopologyOptimizationResult

Table 368: Members

Property CalculateTimeHistory (p. 1220) Gets or sets the CalculateTimeHistory.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Children (p. 1220) Gets the list of children.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Comments (p. 1220) Gets the list of associated comments.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property DataModelObjectCategory (p. 1218)Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1220) Gets or sets the ExclusionsParticipation.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Figures (p. 1220) Gets the list of associated figures.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalMass (p. 1221) Gets the FinalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property FinalVolume (p. 1221) Gets the FinalVolume.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1216 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyElementalDensity

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Images (p. 1221) Gets the list of associated images.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property InternalObject (p. 1218) Gets the internal object. For advanced usage
only.
Property IterationNumber (p. 1221) Gets the IterationNumber.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property IterationStep (p. 1221) Gets or sets the IterationStep.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Location (p. 1222) Gets or sets the Location.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Maximum (p. 1222) Gets the Maximum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Minimum (p. 1222) Gets the Minimum.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalMass (p. 1222) Gets the OriginalMass.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property OriginalVolume (p. 1222) Gets the OriginalVolume.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentMassOfOriginal (p. 1222) Gets the PercentMassOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property PercentVolumeOfOriginal (p. 1223) Gets the PercentVolumeOfOriginal.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property RetainedThreshold (p. 1218) Gets or sets the RetainedThreshold.
Property ScopingMethod (p. 1223) Gets or sets the ScopingMethod.

(Inherited from
TopologyOptimizationResult (p. 1218).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1217
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Selection (p. 1223) Gets or sets the Selection.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property ShowOptimizedRegion (p. 1223) Gets or sets the ShowOptimizedRegion.

(Inherited from
TopologyOptimizationResult (p. 1218).)
Property Suppressed (p. 1223) Gets or sets the Suppressed.

(Inherited from
TopologyOptimizationResult (p. 1218).)

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; }

TopologyOptimizationResult
Defines a TopologyOptimizationResult.

Declaration Syntax
public abstract class TopologyOptimizationResult : DataModelObject, IFolderDataModelObject

Table 369: Members

Property CalculateTimeHistory (p. 1220) Gets or sets the CalculateTimeHistory.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1218 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyOptimizationResult

Property Children (p. 1220) Gets the list of children.

Property Comments (p. 1220) Gets the list of associated comments.
Property DataModelObjectCategory (p. 1220) Gets the current DataModelObject's category.
Property ExclusionsParticipation (p. 1220) Gets or sets the ExclusionsParticipation.
Property Figures (p. 1220) Gets the list of associated figures.
Property FinalMass (p. 1221) Gets the FinalMass.
Property FinalVolume (p. 1221) Gets the FinalVolume.
Property Images (p. 1221) Gets the list of associated images.
Property InternalObject (p. 1221) Gets the internal object. For advanced usage only.
Property IterationNumber (p. 1221) Gets the IterationNumber.
Property IterationStep (p. 1221) Gets or sets the IterationStep.
Property Location (p. 1222) Gets or sets the Location.
Property Maximum (p. 1222) Gets the Maximum.
Property Minimum (p. 1222) Gets the Minimum.
Property OriginalMass (p. 1222) Gets the OriginalMass.
Property OriginalVolume (p. 1222) Gets the OriginalVolume.
Property PercentMassOfOriginal (p. 1222) Gets the PercentMassOfOriginal.
Property PercentVolumeOfOriginal (p. 1223) Gets the PercentVolumeOfOriginal.
Property ScopingMethod (p. 1223) Gets or sets the ScopingMethod.
Property Selection (p. 1223) Gets or sets the Selection.
Property ShowOptimizedRegion (p. 1223) Gets or sets the ShowOptimizedRegion.
Property Suppressed (p. 1223) Gets or sets the Suppressed.
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 ClearGeneratedData() (p. 1224) Clears the result.
Method Delete() (p. 1224) Run the Delete action.
Method EvaluateAllResults() (p. 1224) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1225)
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1225)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1225)
Method RenameBasedOnDefinition() (p. 1226) Run the RenameBasedOnDefinition action.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1219
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

Declaration Syntax
public bool ExclusionsParticipation { set;get; }

Figures
Gets the list of associated figures.

Declaration Syntax
public IEnumerable<Figure> Figures { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1220 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyOptimizationResult

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.

Declaration Syntax
public int IterationNumber { get; }

IterationStep
Gets or sets the IterationStep.

Declaration Syntax
public int IterationStep { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1221
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

Declaration Syntax
public Quantity OriginalVolume { get; }

PercentMassOfOriginal
Gets the PercentMassOfOriginal.

Declaration Syntax
public double PercentMassOfOriginal { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1222 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyOptimizationResult

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.

Declaration Syntax
public bool Suppressed { set;get; }

AddComment()
Creates a new child Comment.

Declaration Syntax
public virtual Comment AddComment()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1223
Ansys.ACT.Automation.Mechanical.Results 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.

ClearGeneratedData()
Clears the result.

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()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1224 of ANSYS, Inc. and its subsidiaries and affiliates.
 TopologyOptimizationResult

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.

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1225
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.)

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

UserDefinedResult
Defines a UserDefinedResult.

Declaration Syntax
public class UserDefinedResult : DataModelObject, IFolderDataModelObject

Table 370: Members

Property Average (p. 1228) Gets the Average.

Property AverageAcrossBodies (p. 1228)
Property By (p. 1229)
Property CalculateTimeHistory (p. 1229)
Property Children (p. 1229)
Property CombinationNumber (p. 1229)
Property CoordinateSystem (p. 1229)
Gets or sets the AverageAcrossBodies.
Gets or sets the By.
Gets or sets the CalculateTimeHistory.
Gets the list of children.
Gets or sets the Combination Number for a Solution
Combination result.
Gets or sets the Coordinate System.
Accepts/Returns None for Solution Coordinate
System in the general case (if applicable).

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1226 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

Accepts/Returns None for Fiber Coordinate System

for a result that is sub scoped by ply.
Property CyclicMode (p. 1230) Gets or sets the CyclicMode.
Property DataModelObjectCategory (p. 1230) Gets the current DataModelObject's category.
Property DisplayOption (p. 1230) Gets or sets the DisplayOption.
Property DisplayTime (p. 1230) Gets or sets the DisplayTime.
Property Expression (p. 1230) Gets or sets the Expression.
Property GlobalIDs (p. 1230) Gets or sets the GlobalIDs.
Property GraphControlsXAxis (p. 1231) Gets or sets the GraphControlsXAxis.
Property Identifier (p. 1231) Gets or sets the Identifier.
Property InputUnitSystem (p. 1231) Gets the InputUnitSystem.
Property InternalObject (p. 1231) Gets the internal object. For advanced usage only.
Property IsSolved (p. 1231) Gets the IsSolved.
Property ItemType (p. 1231) Gets or sets the ItemType.
Property IterationNumber (p. 1232) Gets the IterationNumber.
Property Layer (p. 1232) Gets or sets the Layer.
Property LoadMultiplier (p. 1232) Gets the LoadMultiplier.
Property LoadStep (p. 1232) Gets the LoadStep.
Property LoadStepNumber (p. 1232) Gets or sets the LoadStepNumber.
Property Location (p. 1232) Gets or sets the Location.
Property Maximum (p. 1233) Gets the Maximum.
Property MaximumOccursOn (p. 1233) Gets the MaximumOccursOn.
Property MaximumOfMaximumOverTime (p. 1233)Gets the MaximumOfMaximumOverTime.
Property MaximumOfMinimumOverTime (p. 1233)Gets the MaximumOfMinimumOverTime.
Property Minimum (p. 1233) Gets the Minimum.
Property MinimumOccursOn (p. 1233) Gets the MinimumOccursOn.
Property MinimumOfMaximumOverTime (p. 1234)Gets the MinimumOfMaximumOverTime.
Property MinimumOfMinimumOverTime (p. 1234)Gets the MinimumOfMinimumOverTime.
Property Mode (p. 1234) Gets or sets the Mode (Result Set Number).
Property OutputUnit (p. 1234) Gets or sets the OutputUnit.
Property PhaseIncrement (p. 1234) Gets or sets the PhaseIncrement.
Property Plies (p. 1234) No details are provided for this entry.
Property PlotData (p. 1235) Gets the result table.
Property Ply (p. 1235) Gets or sets the Ply selection.
Property Position (p. 1235) Gets or sets the Position.
Property ReportedFrequency (p. 1235) Gets the ReportedFrequency.
Property RequestedFrequency (p. 1235) Gets or sets the RequestedFrequency.
Property ResponseType (p. 1235) Gets or sets the ResponseType.
Property ScaleFactor (p. 1236) Gets or sets the ScaleFactor.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1227
Ansys.ACT.Automation.Mechanical.Results Namespace

Property ScaleFactorValue (p. 1236) Gets or sets the ScaleFactorValue.

Property ScopingMethod (p. 1236) Gets or sets the ScopingMethod.
Property SetNumber (p. 1236) Gets or sets the Set Number.
Property SolutionCombinationDriver (p. 1236) Gets or sets the SolutionCombinationDriver.
Property SolverComponentIDs (p. 1236) Gets or sets the SolverComponentIDs.
Property SubScopeBy (p. 1237) Gets or sets the SubScopeBy.
Property Substep (p. 1237) Gets the Substep.
Property Suppressed (p. 1237) Gets or sets the Suppressed.
Property SweepingPhase (p. 1237) Gets or sets the SweepingPhase.
Property Time (p. 1237) Gets the Time.
Property Type (p. 1237) Gets the Type.
Method ClearGeneratedData() (p. 1238) Run the ClearGeneratedData action.
Method CreateResultsAtAllSets() (p. 1238) Creates results at all sets for results under a
solution.
Method Delete() (p. 1238) Run the Delete action.
Method DuplicateWithoutResults() (p. 1238) Run the DuplicateWithoutResults action.
Method EvaluateAllResults() (p. 1238) Run the EvaluateAllResults action.
Method ExportAnimation(string, Run the ExportAnimation action.
GraphicsAnimationExportFormat,
AnimationExportSettings) (p. 1238)
Method ExportToTextFile(string) (p. 1239) Run the ExportToTextFile action.
Method FetchRemoteResults() (p. 1239) Run the FetchRemoteResult action.
Method GetChildren<ChildrenType>(bool, Gets the list of children, filtered by type.
IList<ChildrenType>) (p. 1239)
Method GetChildren(DataModelObjectCategory, Gets the list of children, filtered by type.
bool, IList<IDataModelObject>) (p. 1240)
Method PromoteToNamedSelection() (p. 1240) Run the PromoteToNamedSelection action.
Method RenameBasedOnDefinition() (p. 1240) Run the RenameBasedOnDefinition action.

Average
Gets the Average.

Declaration Syntax
public Quantity Average { get; }

AverageAcrossBodies
Gets or sets the AverageAcrossBodies.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1228 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

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; }

CombinationNumber
Gets or sets the Combination Number for a Solution Combination result.

Declaration Syntax
public uint CombinationNumber { set;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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1229
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

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; }

GlobalIDs
Gets or sets the GlobalIDs.

Declaration Syntax
public string GlobalIDs { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1230 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

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; }

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1231
Ansys.ACT.Automation.Mechanical.Results Namespace

IterationNumber
Gets the IterationNumber.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1232 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

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; }

Minimum
Gets the Minimum.

Declaration Syntax
public Quantity Minimum { get; }

MinimumOccursOn
Gets the MinimumOccursOn.

Declaration Syntax
public string MinimumOccursOn { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1233
Ansys.ACT.Automation.Mechanical.Results Namespace

MinimumOfMaximumOverTime
Gets the MinimumOfMaximumOverTime.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1234 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

PlotData
Gets the result table.

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1235
Ansys.ACT.Automation.Mechanical.Results Namespace

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.

Declaration Syntax
public string SolverComponentIDs { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1236 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

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.

Declaration Syntax
public string Type { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1237
Ansys.ACT.Automation.Mechanical.Results Namespace

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()

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1238 of ANSYS, Inc. and its subsidiaries and affiliates.
 UserDefinedResult

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.

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)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1239
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.)

PromoteToNamedSelection()
Run the PromoteToNamedSelection action.

Declaration Syntax
public virtual IEnumerable<NamedSelection> PromoteToNamedSelection()

RenameBasedOnDefinition()
Run the RenameBasedOnDefinition action.

Declaration Syntax
public virtual void RenameBasedOnDefinition()

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1240 of ANSYS, Inc. and its subsidiaries and affiliates.
 VariableGraph

VariableGraph
Defines a VariableGraph.

Declaration Syntax
public class VariableGraph : Result

Table 371: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1244) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1241
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1244) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1242 of ANSYS, Inc. and its subsidiaries and affiliates.
 VariableGraph

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1243
Ansys.ACT.Automation.Mechanical.Results Namespace

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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.

Declaration Syntax
public class Volume : Result

Table 372: Members

Property Amplitude (p. 1248) Gets or sets the Amplitude.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1244 of ANSYS, Inc. and its subsidiaries and affiliates.
 Volume

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1248) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1248) Gets or sets the Frequency.
Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1245
Ansys.ACT.Automation.Mechanical.Results Namespace

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1248) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1246 of ANSYS, Inc. and its subsidiaries and affiliates.
 Volume

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PhaseIncrement (p. 1249) Gets or sets the PhaseIncrement.
Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1249) Gets or sets the SweepingPhase.
Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1247
Ansys.ACT.Automation.Mechanical.Results Namespace

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property Total (p. 1249) Gets the Total.

Amplitude
Gets or sets the Amplitude.

Declaration Syntax
public bool Amplitude { set;get; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1248 of ANSYS, Inc. and its subsidiaries and affiliates.
 Volume

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; }

Total
Gets the Total.

Declaration Syntax
public Quantity Total { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1249
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1250 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 373: Members

AccelerationPhaseResponse (p. 1251) Defines a

AccelerationPhaseResponse.
DeformationPhaseResponse (p. 1255) Defines a
DeformationPhaseResponse.
ElasticStrainPhaseResponse (p. 1258) Defines a
ElasticStrainPhaseResponse.
StressPhaseResponse (p. 1262) Defines a StressPhaseResponse.
VelocityPhaseResponse (p. 1265) Defines a
VelocityPhaseResponse.

AccelerationPhaseResponse
Defines a AccelerationPhaseResponse.

Declaration Syntax
public class AccelerationPhaseResponse : ResultChart

Table 374: Members

Property AccelerationType (p. 1190) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1188).)

Property BoundaryCondition (p. 1190) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1188).)

Property ChartDimensions (p. 1190) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1188).)

Property ChartViewingStyle (p. 1190) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1251
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property Children (p. 1191) Gets the list of children.

(Inherited from ResultChart (p. 1188).)

Property Comments (p. 1191) Gets the list of associated comments.

(Inherited from ResultChart (p. 1188).)

Property ContactRegion (p. 1254) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 1191) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1188).)

Property CurvesAppearanceDisplay (p. 1191) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1188).)

Property CutFrequency (p. 1191) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1188).)

Property DataModelObjectCategory (p. 1254) Gets the current DataModelObject's
category.
Property DeformationType (p. 1192) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1188).)

Property DpfEvaluation (p. 1192) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1188).)

Property Duration (p. 1192) Gets or sets the Duration.

(Inherited from ResultChart (p. 1188).)

Property EnhancedTracking (p. 1192) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1188).)

Property FilterMaximum (p. 1192) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1188).)

Property FilterMinimum (p. 1192) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1188).)

Property FilterType (p. 1193) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1188).)

Property FrequencyAtMaximumAmplitude (p. 1193)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property GeometrySelectionString (p. 1193) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1188).)

Property Images (p. 1193) Gets the list of associated images.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1252 of ANSYS, Inc. and its subsidiaries and affiliates.
 AccelerationPhaseResponse

Property ImaginaryAtMaximumAmplitude (p. 1193)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property InternalObject (p. 1254) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 1194) Gets the IsSolved.

(Inherited from ResultChart (p. 1188).)

Property LoadStepNumber (p. 1194) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1188).)

Property Location (p. 1194) Gets or sets the Location.

(Inherited from ResultChart (p. 1188).)

Property Maximum (p. 1194) Gets the Maximum.

(Inherited from ResultChart (p. 1188).)

Property MaximumAmplitude (p. 1194) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property MaximumFrequency (p. 1194) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1188).)

Property Minimum (p. 1195) Gets the Minimum.

(Inherited from ResultChart (p. 1188).)

Property MinimumFrequency (p. 1195) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1188).)

Property NormalOrientation (p. 1195) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1188).)

Property PhaseAngle (p. 1195) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1188).)

Property RealAtMaximumAmplitude (p. 1195) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property ReportedFrequency (p. 1195) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1188).)

Property RequestedFrequency (p. 1196) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1188).)

Property ResultChartType (p. 1196) Gets the ResultChartType.

(Inherited from ResultChart (p. 1188).)

Property SectorNumber (p. 1196) Gets or sets the SectorNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1253
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 1188).)

Property ShearOrientation (p. 1196) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1188).)

Property SpatialResolution (p. 1196) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1188).)

Property Spring (p. 1196) Gets or sets the Spring.

(Inherited from ResultChart (p. 1188).)

Property StressStrainType (p. 1197) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1188).)

Property Suppressed (p. 1197) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1188).)

Property TimeHistoryDisplay (p. 1197) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1188).)

Property UseParentFrequencyRange (p. 1197) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1188).)

Property VelocityType (p. 1197) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1188).)

Property XAxisValues (p. 1197) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1188).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1254 of ANSYS, Inc. and its subsidiaries and affiliates.
 DeformationPhaseResponse

Declaration Syntax
public IDSResultChartAuto InternalObject { get; }

DeformationPhaseResponse
Defines a DeformationPhaseResponse.

Declaration Syntax
public class DeformationPhaseResponse : ResultChart

Table 375: Members

Property AccelerationType (p. 1190) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1188).)

Property BoundaryCondition (p. 1190) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1188).)

Property ChartDimensions (p. 1190) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1188).)

Property ChartViewingStyle (p. 1190) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1188).)

Property Children (p. 1191) Gets the list of children.

(Inherited from ResultChart (p. 1188).)

Property Comments (p. 1191) Gets the list of associated comments.

(Inherited from ResultChart (p. 1188).)

Property CoordinateSystem (p. 1191) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1188).)

Property CurvesAppearanceDisplay (p. 1191) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1188).)

Property CutFrequency (p. 1191) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1188).)

Property DataModelObjectCategory (p. 1258) Gets the current DataModelObject's
category.
Property DeformationType (p. 1192) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1188).)

Property DpfEvaluation (p. 1192) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1255
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property Duration (p. 1192) Gets or sets the Duration.

(Inherited from ResultChart (p. 1188).)

Property EnhancedTracking (p. 1192) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1188).)

Property FilterMaximum (p. 1192) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1188).)

Property FilterMinimum (p. 1192) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1188).)

Property FilterType (p. 1193) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1188).)

Property FrequencyAtMaximumAmplitude (p. 1193)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property GeometrySelectionString (p. 1193) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1188).)

Property Images (p. 1193) Gets the list of associated images.

(Inherited from ResultChart (p. 1188).)

Property ImaginaryAtMaximumAmplitude (p. 1193)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property InternalObject (p. 1258) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 1194) Gets the IsSolved.

(Inherited from ResultChart (p. 1188).)

Property LoadStepNumber (p. 1194) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1188).)

Property Location (p. 1194) Gets or sets the Location.

(Inherited from ResultChart (p. 1188).)

Property Maximum (p. 1194) Gets the Maximum.

(Inherited from ResultChart (p. 1188).)

Property MaximumAmplitude (p. 1194) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property MaximumFrequency (p. 1194) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1188).)

Property Minimum (p. 1195) Gets the Minimum.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1256 of ANSYS, Inc. and its subsidiaries and affiliates.
 DeformationPhaseResponse

(Inherited from ResultChart (p. 1188).)

Property MinimumFrequency (p. 1195) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1188).)

Property NormalOrientation (p. 1195) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1188).)

Property PhaseAngle (p. 1195) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1188).)

Property RealAtMaximumAmplitude (p. 1195) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property ReportedFrequency (p. 1195) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1188).)

Property RequestedFrequency (p. 1196) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1188).)

Property ResultChartType (p. 1196) Gets the ResultChartType.

(Inherited from ResultChart (p. 1188).)

Property SectorNumber (p. 1196) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1188).)

Property ShearOrientation (p. 1196) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1188).)

Property SpatialResolution (p. 1196) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1188).)

Property Spring (p. 1196) Gets or sets the Spring.

(Inherited from ResultChart (p. 1188).)

Property StressStrainType (p. 1197) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1188).)

Property Suppressed (p. 1197) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1188).)

Property TimeHistoryDisplay (p. 1197) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1188).)

Property UseParentFrequencyRange (p. 1197) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1188).)

Property VelocityType (p. 1197) Gets or sets the VelocityType.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1257
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 1188).)

Property XAxisValues (p. 1197) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1188).)

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 376: Members

Property AccelerationType (p. 1190) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1188).)

Property BoundaryCondition (p. 1190) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1188).)

Property ChartDimensions (p. 1190) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1188).)

Property ChartViewingStyle (p. 1190) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1188).)

Property Children (p. 1191) Gets the list of children.

(Inherited from ResultChart (p. 1188).)

Property Comments (p. 1191) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1258 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElasticStrainPhaseResponse

(Inherited from ResultChart (p. 1188).)

Property ContactRegion (p. 1261) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 1191) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1188).)

Property CurvesAppearanceDisplay (p. 1191) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1188).)

Property CutFrequency (p. 1191) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1188).)

Property DataModelObjectCategory (p. 1261) Gets the current DataModelObject's
category.
Property DeformationType (p. 1192) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1188).)

Property DpfEvaluation (p. 1192) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1188).)

Property Duration (p. 1192) Gets or sets the Duration.

(Inherited from ResultChart (p. 1188).)

Property EnhancedTracking (p. 1192) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1188).)

Property FilterMaximum (p. 1192) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1188).)

Property FilterMinimum (p. 1192) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1188).)

Property FilterType (p. 1193) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1188).)

Property FrequencyAtMaximumAmplitude (p. 1193)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property GeometrySelectionString (p. 1193) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1188).)

Property Images (p. 1193) Gets the list of associated images.

(Inherited from ResultChart (p. 1188).)

Property ImaginaryAtMaximumAmplitude (p. 1193)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property InternalObject (p. 1261) Gets the internal object. For advanced usage
only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1259
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property IsSolved (p. 1194) Gets the IsSolved.

(Inherited from ResultChart (p. 1188).)

Property LoadStepNumber (p. 1194) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1188).)

Property Location (p. 1194) Gets or sets the Location.

(Inherited from ResultChart (p. 1188).)

Property Maximum (p. 1194) Gets the Maximum.

(Inherited from ResultChart (p. 1188).)

Property MaximumAmplitude (p. 1194) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property MaximumFrequency (p. 1194) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1188).)

Property Minimum (p. 1195) Gets the Minimum.

(Inherited from ResultChart (p. 1188).)

Property MinimumFrequency (p. 1195) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1188).)

Property NormalOrientation (p. 1195) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1188).)

Property PhaseAngle (p. 1195) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1188).)

Property RealAtMaximumAmplitude (p. 1195) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property ReportedFrequency (p. 1195) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1188).)

Property RequestedFrequency (p. 1196) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1188).)

Property ResultChartType (p. 1196) Gets the ResultChartType.

(Inherited from ResultChart (p. 1188).)

Property SectorNumber (p. 1196) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1188).)

Property ShearOrientation (p. 1196) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1260 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElasticStrainPhaseResponse

Property SpatialResolution (p. 1196) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1188).)

Property Spring (p. 1196) Gets or sets the Spring.

(Inherited from ResultChart (p. 1188).)

Property StressStrainType (p. 1197) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1188).)

Property Suppressed (p. 1197) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1188).)

Property TimeHistoryDisplay (p. 1197) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1188).)

Property UseParentFrequencyRange (p. 1197) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1188).)

Property VelocityType (p. 1197) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1188).)

Property XAxisValues (p. 1197) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1188).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1261
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

StressPhaseResponse
Defines a StressPhaseResponse.

Declaration Syntax
public class StressPhaseResponse : ResultChart

Table 377: Members

Property AccelerationType (p. 1190) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1188).)

Property BoundaryCondition (p. 1190) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1188).)

Property ChartDimensions (p. 1190) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1188).)

Property ChartViewingStyle (p. 1190) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1188).)

Property Children (p. 1191) Gets the list of children.

(Inherited from ResultChart (p. 1188).)

Property Comments (p. 1191) Gets the list of associated comments.

(Inherited from ResultChart (p. 1188).)

Property CoordinateSystem (p. 1191) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1188).)

Property CurvesAppearanceDisplay (p. 1191) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1188).)

Property CutFrequency (p. 1191) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1188).)

Property DataModelObjectCategory (p. 1265) Gets the current DataModelObject's
category.
Property DeformationType (p. 1192) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1188).)

Property DpfEvaluation (p. 1192) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1188).)

Property Duration (p. 1192) Gets or sets the Duration.

(Inherited from ResultChart (p. 1188).)

Property EnhancedTracking (p. 1192) Gets the EnhancedTracking.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1262 of ANSYS, Inc. and its subsidiaries and affiliates.
 StressPhaseResponse

(Inherited from ResultChart (p. 1188).)

Property FilterMaximum (p. 1192) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1188).)

Property FilterMinimum (p. 1192) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1188).)

Property FilterType (p. 1193) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1188).)

Property FrequencyAtMaximumAmplitude (p. 1193)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property GeometrySelectionString (p. 1193) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1188).)

Property Images (p. 1193) Gets the list of associated images.

(Inherited from ResultChart (p. 1188).)

Property ImaginaryAtMaximumAmplitude (p. 1193)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property InternalObject (p. 1265) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 1194) Gets the IsSolved.

(Inherited from ResultChart (p. 1188).)

Property LoadStepNumber (p. 1194) Gets or sets the LoadStepNumber.

(Inherited from ResultChart (p. 1188).)

Property Location (p. 1194) Gets or sets the Location.

(Inherited from ResultChart (p. 1188).)

Property Maximum (p. 1194) Gets the Maximum.

(Inherited from ResultChart (p. 1188).)

Property MaximumAmplitude (p. 1194) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property MaximumFrequency (p. 1194) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1188).)

Property Minimum (p. 1195) Gets the Minimum.

(Inherited from ResultChart (p. 1188).)

Property MinimumFrequency (p. 1195) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1263
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property NormalOrientation (p. 1195) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1188).)

Property PhaseAngle (p. 1195) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1188).)

Property RealAtMaximumAmplitude (p. 1195) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property ReportedFrequency (p. 1195) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1188).)

Property RequestedFrequency (p. 1196) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1188).)

Property ResultChartType (p. 1196) Gets the ResultChartType.

(Inherited from ResultChart (p. 1188).)

Property SectorNumber (p. 1196) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1188).)

Property ShearOrientation (p. 1196) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1188).)

Property SpatialResolution (p. 1196) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1188).)

Property Spring (p. 1196) Gets or sets the Spring.

(Inherited from ResultChart (p. 1188).)

Property StressStrainType (p. 1197) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1188).)

Property Suppressed (p. 1197) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1188).)

Property TimeHistoryDisplay (p. 1197) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1188).)

Property UseParentFrequencyRange (p. 1197) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1188).)

Property VelocityType (p. 1197) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1188).)

Property XAxisValues (p. 1197) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1264 of ANSYS, Inc. and its subsidiaries and affiliates.
 VelocityPhaseResponse

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.

Declaration Syntax
public class VelocityPhaseResponse : ResultChart

Table 378: Members

Property AccelerationType (p. 1190) Gets or sets the AccelerationType.

(Inherited from ResultChart (p. 1188).)

Property BoundaryCondition (p. 1190) Gets or sets the BoundaryCondition.

(Inherited from ResultChart (p. 1188).)

Property ChartDimensions (p. 1190) Gets or sets the Chart Dimensions

(Inherited from ResultChart (p. 1188).)

Property ChartViewingStyle (p. 1190) Gets or sets the ChartViewingStyle.

(Inherited from ResultChart (p. 1188).)

Property Children (p. 1191) Gets the list of children.

(Inherited from ResultChart (p. 1188).)

Property Comments (p. 1191) Gets the list of associated comments.

(Inherited from ResultChart (p. 1188).)

Property ContactRegion (p. 1268) Gets or sets the ContactRegion.
Property CoordinateSystem (p. 1191) Gets or sets the CoordinateSystem.

(Inherited from ResultChart (p. 1188).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1265
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

Property CurvesAppearanceDisplay (p. 1191) Gets or sets the CurvesAppearanceDisplay.

(Inherited from ResultChart (p. 1188).)

Property CutFrequency (p. 1191) Gets or sets the CutFrequency.

(Inherited from ResultChart (p. 1188).)

Property DataModelObjectCategory (p. 1268) Gets the current DataModelObject's
category.
Property DeformationType (p. 1192) Gets or sets the DeformationType.

(Inherited from ResultChart (p. 1188).)

Property DpfEvaluation (p. 1192) Gets or sets the DpfEvaluation.

(Inherited from ResultChart (p. 1188).)

Property Duration (p. 1192) Gets or sets the Duration.

(Inherited from ResultChart (p. 1188).)

Property EnhancedTracking (p. 1192) Gets the EnhancedTracking.

(Inherited from ResultChart (p. 1188).)

Property FilterMaximum (p. 1192) Gets the FilterMaximum.

(Inherited from ResultChart (p. 1188).)

Property FilterMinimum (p. 1192) Gets the FilterMinimum.

(Inherited from ResultChart (p. 1188).)

Property FilterType (p. 1193) Gets or sets the FilterType.

(Inherited from ResultChart (p. 1188).)

Property FrequencyAtMaximumAmplitude (p. 1193)Gets the FrequencyAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property GeometrySelectionString (p. 1193) Gets or sets the GeometrySelectionString.

(Inherited from ResultChart (p. 1188).)

Property Images (p. 1193) Gets the list of associated images.

(Inherited from ResultChart (p. 1188).)

Property ImaginaryAtMaximumAmplitude (p. 1193)Gets the ImaginaryAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property InternalObject (p. 1268) Gets the internal object. For advanced usage
only.
Property IsSolved (p. 1194) Gets the IsSolved.

(Inherited from ResultChart (p. 1188).)

Property LoadStepNumber (p. 1194) Gets or sets the LoadStepNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1266 of ANSYS, Inc. and its subsidiaries and affiliates.
 VelocityPhaseResponse

(Inherited from ResultChart (p. 1188).)

Property Location (p. 1194) Gets or sets the Location.

(Inherited from ResultChart (p. 1188).)

Property Maximum (p. 1194) Gets the Maximum.

(Inherited from ResultChart (p. 1188).)

Property MaximumAmplitude (p. 1194) Gets the MaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property MaximumFrequency (p. 1194) Gets or sets the MaximumFrequency.

(Inherited from ResultChart (p. 1188).)

Property Minimum (p. 1195) Gets the Minimum.

(Inherited from ResultChart (p. 1188).)

Property MinimumFrequency (p. 1195) Gets or sets the MinimumFrequency.

(Inherited from ResultChart (p. 1188).)

Property NormalOrientation (p. 1195) Gets or sets the NormalOrientation.

(Inherited from ResultChart (p. 1188).)

Property PhaseAngle (p. 1195) Gets the PhaseAngle.

(Inherited from ResultChart (p. 1188).)

Property RealAtMaximumAmplitude (p. 1195) Gets the RealAtMaximumAmplitude.

(Inherited from ResultChart (p. 1188).)

Property ReportedFrequency (p. 1195) Gets the ReportedFrequency.

(Inherited from ResultChart (p. 1188).)

Property RequestedFrequency (p. 1196) Gets or sets the RequestedFrequency.

(Inherited from ResultChart (p. 1188).)

Property ResultChartType (p. 1196) Gets the ResultChartType.

(Inherited from ResultChart (p. 1188).)

Property SectorNumber (p. 1196) Gets or sets the SectorNumber.

(Inherited from ResultChart (p. 1188).)

Property ShearOrientation (p. 1196) Gets or sets the ShearOrientation.

(Inherited from ResultChart (p. 1188).)

Property SpatialResolution (p. 1196) Gets or sets the SpatialResolution.

(Inherited from ResultChart (p. 1188).)

Property Spring (p. 1196) Gets or sets the Spring.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1267
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace

(Inherited from ResultChart (p. 1188).)

Property StressStrainType (p. 1197) Gets or sets the StressStrainType.

(Inherited from ResultChart (p. 1188).)

Property Suppressed (p. 1197) Gets or sets the Suppressed.

(Inherited from ResultChart (p. 1188).)

Property TimeHistoryDisplay (p. 1197) Gets or sets the TimeHistoryDisplay.

(Inherited from ResultChart (p. 1188).)

Property UseParentFrequencyRange (p. 1197) Gets or sets the UseParentFrequencyRange.

(Inherited from ResultChart (p. 1188).)

Property VelocityType (p. 1197) Gets or sets the VelocityType.

(Inherited from ResultChart (p. 1188).)

Property XAxisValues (p. 1197) Gets or sets the XAxisValues.

(Inherited from ResultChart (p. 1188).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1268 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 379: Members

AccumulatedEquivalentPlasticStrain (p. 1269) Defines a

AccumulatedEquivalentPlasticStrain.
DirectionalThermalStrain (p. 1274)
ElasticStrainIntensity (p. 1279)
EquivalentCreepStrain (p. 1284)
EquivalentCreepStrainRST (p. 1289)
EquivalentElasticStrain (p. 1294)
EquivalentElasticStrainRST (p. 1299)
EquivalentPlasticStrain (p. 1304)
EquivalentPlasticStrainRST (p. 1309)
EquivalentTotalStrain (p. 1313)
MaximumPrincipalElasticStrain (p. 1318)
MaximumPrincipalThermalStrain (p. 1324)
MaximumShearElasticStrain (p. 1328)
MiddlePrincipalElasticStrain (p. 1333)
MiddlePrincipalThermalStrain (p. 1338)
MinimumPrincipalElasticStrain (p. 1343)
NormalElasticStrain (p. 1348)
ShearElasticStrain (p. 1353)
StrainResult (p. 1359)
VectorPrincipalElasticStrain (p. 1366)
Defines a DirectionalThermalStrain.
Defines a ElasticStrainIntensity.
Defines a EquivalentCreepStrain.
Defines a EquivalentCreepStrainRST.
Defines a EquivalentElasticStrain.
Defines a EquivalentElasticStrainRST.
Defines a EquivalentPlasticStrain.
Defines a EquivalentPlasticStrainRST.
Defines a EquivalentTotalStrain.
Defines a MaximumPrincipalElasticStrain.
Defines a
MaximumPrincipalThermalStrain.
Defines a MaximumShearElasticStrain.
Defines a MiddlePrincipalElasticStrain.
Defines a MiddlePrincipalThermalStrain.
Defines a MinimumPrincipalElasticStrain.
Defines a NormalElasticStrain.
Defines a ShearElasticStrain.
Defines a StrainResult.
Defines a VectorPrincipalElasticStrain.

AccumulatedEquivalentPlasticStrain
Defines a AccumulatedEquivalentPlasticStrain.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1269
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class AccumulatedEquivalentPlasticStrain : StrainResult

Table 380: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1274) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1270 of ANSYS, Inc. and its subsidiaries and affiliates.
 AccumulatedEquivalentPlasticStrain

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1274) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1271
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1272 of ANSYS, Inc. and its subsidiaries and affiliates.
 AccumulatedEquivalentPlasticStrain

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1273
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

DirectionalThermalStrain
Defines a DirectionalThermalStrain.

Declaration Syntax
public class DirectionalThermalStrain : StrainResult

Table 381: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1274 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalThermalStrain

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1279) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1275
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1279) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1276 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalThermalStrain

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property NormalOrientation (p. 1279) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1277
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1278 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElasticStrainIntensity

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1279
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class ElasticStrainIntensity : StrainResult

Table 382: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1284) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1280 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElasticStrainIntensity

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1284) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1281
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1282 of ANSYS, Inc. and its subsidiaries and affiliates.
 ElasticStrainIntensity

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1283
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 383: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1284 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentCreepStrain

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1289) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1285
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1289) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1286 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentCreepStrain

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1287
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1288 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentCreepStrainRST

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

EquivalentCreepStrainRST
Defines a EquivalentCreepStrainRST.

Declaration Syntax
public class EquivalentCreepStrainRST : StrainResult

Table 384: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1289
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1294) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1290 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentCreepStrainRST

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1294) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1291
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1292 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentCreepStrainRST

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1293
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

EquivalentElasticStrain
Defines a EquivalentElasticStrain.

Declaration Syntax
public class EquivalentElasticStrain : StrainResult

Table 385: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1294 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentElasticStrain

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1299) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1295
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1299) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1296 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentElasticStrain

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1297
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1298 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentElasticStrainRST

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 386: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1299
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1303) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1300 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentElasticStrainRST

Property InternalObject (p. 1304) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1301
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1302 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentElasticStrainRST

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1303
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

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 387: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1304 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentPlasticStrain

(Inherited from Result (p. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1308) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1308) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1305
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1306 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentPlasticStrain

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1307
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1308 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentPlasticStrainRST

EquivalentPlasticStrainRST
Defines a EquivalentPlasticStrainRST.

Declaration Syntax
public class EquivalentPlasticStrainRST : StrainResult

Table 388: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1313) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1309
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1313) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1310 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentPlasticStrainRST

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1311
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1312 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentTotalStrain

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

EquivalentTotalStrain
Defines a EquivalentTotalStrain.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1313
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class EquivalentTotalStrain : StrainResult

Table 389: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1318) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1314 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentTotalStrain

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1318) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1315
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1316 of ANSYS, Inc. and its subsidiaries and affiliates.
 EquivalentTotalStrain

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1317
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 390: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1318 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumPrincipalElasticStrain

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1323) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1319
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1323) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property Layer (p. 1323) Gets or sets the Layer.
Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1320 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumPrincipalElasticStrain

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property NormalOrientation (p. 1323) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1321
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1322 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumPrincipalElasticStrain

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1323
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

MaximumPrincipalThermalStrain
Defines a MaximumPrincipalThermalStrain.

Declaration Syntax
public class MaximumPrincipalThermalStrain : StrainResult

Table 391: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1328) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1324 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumPrincipalThermalStrain

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1328) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1325
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1326 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumPrincipalThermalStrain

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1327
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1328 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumShearElasticStrain

Declaration Syntax
public class MaximumShearElasticStrain : StrainResult

Table 392: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1333) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1329
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1333) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1330 of ANSYS, Inc. and its subsidiaries and affiliates.
 MaximumShearElasticStrain

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1331
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property ShearOrientation (p. 1333) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1332 of ANSYS, Inc. and its subsidiaries and affiliates.
 MiddlePrincipalElasticStrain

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1333
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class MiddlePrincipalElasticStrain : StrainResult

Table 393: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1338) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1334 of ANSYS, Inc. and its subsidiaries and affiliates.
 MiddlePrincipalElasticStrain

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1338) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1335
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1336 of ANSYS, Inc. and its subsidiaries and affiliates.
 MiddlePrincipalElasticStrain

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1337
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

MiddlePrincipalThermalStrain
Defines a MiddlePrincipalThermalStrain.

Declaration Syntax
public class MiddlePrincipalThermalStrain : StrainResult

Table 394: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1338 of ANSYS, Inc. and its subsidiaries and affiliates.
 MiddlePrincipalThermalStrain

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1343) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1339
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1343) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1340 of ANSYS, Inc. and its subsidiaries and affiliates.
 MiddlePrincipalThermalStrain

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1341
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1342 of ANSYS, Inc. and its subsidiaries and affiliates.
 MinimumPrincipalElasticStrain

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 395: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1343
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1348) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1344 of ANSYS, Inc. and its subsidiaries and affiliates.
 MinimumPrincipalElasticStrain

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1348) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1345
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1346 of ANSYS, Inc. and its subsidiaries and affiliates.
 MinimumPrincipalElasticStrain

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1347
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 396: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1348 of ANSYS, Inc. and its subsidiaries and affiliates.
 NormalElasticStrain

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1353) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1349
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1353) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1350 of ANSYS, Inc. and its subsidiaries and affiliates.
 NormalElasticStrain

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property NormalOrientation (p. 1353) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScaleFactor (p. 1353) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1353) Gets or sets the ScaleFactorValue.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1351
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1352 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShearElasticStrain

(Inherited from Result (p. 1174).)

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; }

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1353
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Declaration Syntax
public class ShearElasticStrain : StrainResult

Table 397: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1358) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1354 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShearElasticStrain

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1358) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1355
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1356 of ANSYS, Inc. and its subsidiaries and affiliates.
 ShearElasticStrain

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScaleFactor (p. 1358) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1359) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property ShearOrientation (p. 1359) Gets or sets the ShearOrientation.
Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1357
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1358 of ANSYS, Inc. and its subsidiaries and affiliates.
 StrainResult

ScaleFactorValue
Gets or sets the ScaleFactorValue.

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 398: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.
Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1359
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.
Property DataModelObjectCategory (p. 1363) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.
Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.
Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.
Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1364) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1360 of ANSYS, Inc. and its subsidiaries and affiliates.
 StrainResult

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.
Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.
Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1361
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.
Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.
Property Plies (p. 1365) No details are provided for this entry.
Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.
Property Position (p. 1365) Gets or sets the Position.
Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.
Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.
Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.
Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.
Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1362 of ANSYS, Inc. and its subsidiaries and affiliates.
 StrainResult

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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.

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.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1363
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

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.

Declaration Syntax
public int IterationStep { set;get; }

LoadMultiplier
Gets the LoadMultiplier.

Declaration Syntax
public double LoadMultiplier { get; }

Mode
Gets or sets the Mode.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1364 of ANSYS, Inc. and its subsidiaries and affiliates.
 StrainResult

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.

Declaration Syntax
public ShellFaceType Position { set;get; }

ReportedFrequency
Gets the ReportedFrequency.

Declaration Syntax
public Quantity ReportedFrequency { get; }

StressStrainType
Gets or sets the StressStrainType.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1365
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

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 399: Members

Property Amplitude (p. 1363) Gets or sets the Amplitude.

(Inherited from StrainResult (p. 1359).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property AverageAcrossBodies (p. 1363) Gets or sets the AverageAcrossBodies.

(Inherited from StrainResult (p. 1359).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1366 of ANSYS, Inc. and its subsidiaries and affiliates.
 VectorPrincipalElasticStrain

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1363) Gets or sets the CyclicMode.

(Inherited from StrainResult (p. 1359).)

Property DataModelObjectCategory (p. 1370) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1363) Gets or sets the EnvironmentSelection.

(Inherited from StrainResult (p. 1359).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1364) Gets or sets the Frequency.

(Inherited from StrainResult (p. 1359).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1364) Gets or sets the HarmonicIndex.

(Inherited from StrainResult (p. 1359).)

Property Identifier (p. 1178) Gets or sets the Identifier.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1367
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1371) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1364) Gets or sets the IterationStep.

(Inherited from StrainResult (p. 1359).)

Property LoadMultiplier (p. 1364) Gets the LoadMultiplier.

(Inherited from StrainResult (p. 1359).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1368 of ANSYS, Inc. and its subsidiaries and affiliates.
 VectorPrincipalElasticStrain

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1364) Gets or sets the Mode.

(Inherited from StrainResult (p. 1359).)

Property PhaseIncrement (p. 1365) Gets or sets the PhaseIncrement.

(Inherited from StrainResult (p. 1359).)

Property Plies (p. 1365) No details are provided for this entry.

(Inherited from StrainResult (p. 1359).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Ply (p. 1365) Gets or sets the Ply selection.

(Inherited from StrainResult (p. 1359).)

Property Position (p. 1365) Gets or sets the Position.

(Inherited from StrainResult (p. 1359).)

Property ReportedFrequency (p. 1365) Gets the ReportedFrequency.

(Inherited from StrainResult (p. 1359).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1369
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property StressStrainType (p. 1365) Gets or sets the StressStrainType.

(Inherited from StrainResult (p. 1359).)

Property SubScopeBy (p. 1366) Gets or sets the SubScopeBy.

(Inherited from StrainResult (p. 1359).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1366) Gets or sets the SweepingPhase.

(Inherited from StrainResult (p. 1359).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1370 of ANSYS, Inc. and its subsidiaries and affiliates.
 VectorPrincipalElasticStrain

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Declaration Syntax
public IDSResultAuto InternalObject { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1371
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1372 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.DeformationResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.DeformationResults

Table 400: Members

DeformationResult (p. 1373) Defines a DeformationResult.

DirectionalAcceleration (p. 1382) Defines a
DirectionalAcceleration.
DirectionalAccelerationPSD (p. 1387) Defines a
DirectionalAccelerationPSD.
DirectionalAccelerationRS (p. 1392) Defines a
DirectionalAccelerationRS.
DirectionalDeformation (p. 1398) Defines a
DirectionalDeformation.
DirectionalVelocity (p. 1403) Defines a DirectionalVelocity.
DirectionalVelocityPSD (p. 1409) Defines a
DirectionalVelocityPSD.
DirectionalVelocityRS (p. 1414) Defines a DirectionalVelocityRS.
TotalAcceleration (p. 1419) Defines a TotalAcceleration.
TotalDeformation (p. 1425) Defines a TotalDeformation.
TotalVelocity (p. 1430) Defines a TotalVelocity.
VectorDeformation (p. 1435) Defines a VectorDeformation.

DeformationResult
Defines a DeformationResult.

Declaration Syntax
public abstract class DeformationResult : Result

Table 401: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1373
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property Amplitude (p. 1378) Gets or sets the Amplitude.

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.
Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.
Property DampedFrequency (p. 1378) Gets the DampedFrequency.
Property DataModelObjectCategory (p. 1378) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.
Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1374 of ANSYS, Inc. and its subsidiaries and affiliates.
 DeformationResult

Property Frequency (p. 1379) Gets or sets the Frequency.

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.
Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1379) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.
Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.
Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1375
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.
Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.
Property Mode (p. 1380) Gets or sets the Mode.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.
Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.
Property Reference (p. 1381) Gets the Reference.
Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.
Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.
Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.
Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1376 of ANSYS, Inc. and its subsidiaries and affiliates.
 DeformationResult

Property SolutionCombinationDriver (p. 1182) Gets or sets the

SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.
Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.
Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

AccelerationInG
Gets or sets the AccelerationInG.

Declaration Syntax
public bool AccelerationInG { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1377
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

AllowPhaseSweep
Gets or sets the AllowPhaseSweep.

Declaration Syntax
public bool AllowPhaseSweep { set;get; }

Amplitude
Gets or sets the Amplitude.

Declaration Syntax
public bool Amplitude { set;get; }

CyclicMode
Gets or sets the CyclicMode.

Declaration Syntax
public uint CyclicMode { set;get; }

CyclicPhase
Gets or sets the CyclicPhase.

Declaration Syntax
public Quantity CyclicPhase { set;get; }

DampedFrequency
Gets the DampedFrequency.

Declaration Syntax
public Quantity DampedFrequency { get; }

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1378 of ANSYS, Inc. and its subsidiaries and affiliates.
 DeformationResult

DeformationType
Gets or sets the DeformationType.

Declaration Syntax
public TotalOrDirectional DeformationType { set;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.

Declaration Syntax
public int IterationStep { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1379
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

LoadMultiplier
Gets the LoadMultiplier.

Declaration Syntax
public double LoadMultiplier { get; }

LogarithmicDecrement
Gets the LogarithmicDecrement.

Declaration Syntax
public double LogarithmicDecrement { get; }

ModalDampingRatio
Gets the ModalDampingRatio.

Declaration Syntax
public double ModalDampingRatio { 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; }

Probability
Gets the Probability.

Declaration Syntax
public double Probability { get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1380 of ANSYS, Inc. and its subsidiaries and affiliates.
 DeformationResult

Reference
Gets the Reference.

Declaration Syntax
public ResultRelativityType Reference { get; }

ReportedFrequency
Gets the ReportedFrequency.

Declaration Syntax
public Quantity ReportedFrequency { 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; }

Stability
Gets the Stability.

Declaration Syntax
public Quantity Stability { get; }

SweepingPhase
Gets or sets the SweepingPhase.

Declaration Syntax
public Quantity SweepingPhase { set;get; }

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1381
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

DirectionalAcceleration
Defines a DirectionalAcceleration.

Declaration Syntax
public class DirectionalAcceleration : DeformationResult

Table 402: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1382 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAcceleration

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1386) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1387) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1383
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1384 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAcceleration

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1387) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1385
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1386 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAccelerationPSD

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; }

DirectionalAccelerationPSD
Defines a DirectionalAccelerationPSD.

Declaration Syntax
public class DirectionalAccelerationPSD : DeformationResult

Table 403: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1387
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1392) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1388 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAccelerationPSD

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1392) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1389
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1392) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1390 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAccelerationPSD

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1391
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

DirectionalAccelerationRS
Defines a DirectionalAccelerationRS.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1392 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAccelerationRS

Declaration Syntax
public class DirectionalAccelerationRS : DeformationResult

Table 404: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1393
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1397) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1397) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1394 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAccelerationRS

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1395
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1398) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1396 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalAccelerationRS

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1397
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Declaration Syntax
public IDSResultAuto InternalObject { get; }

NormalOrientation
Gets or sets the NormalOrientation.

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

DirectionalDeformation
Defines a DirectionalDeformation.

Declaration Syntax
public class DirectionalDeformation : DeformationResult

Table 405: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1398 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalDeformation

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1403) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1399
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1403) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1400 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalDeformation

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1403) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1401
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1402 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocity

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

DirectionalVelocity
Defines a DirectionalVelocity.

Declaration Syntax
public class DirectionalVelocity : DeformationResult

Table 406: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1403
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1408) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1404 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocity

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1408) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1405
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1406 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocity

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1408) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1407
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1408 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocityPSD

Declaration Syntax
public NormalOrientationType NormalOrientation { set;get; }

DirectionalVelocityPSD
Defines a DirectionalVelocityPSD.

Declaration Syntax
public class DirectionalVelocityPSD : DeformationResult

Table 407: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1409
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1414) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1410 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocityPSD

Property InternalObject (p. 1414) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1411
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1414) Gets or sets the NormalOrientation.
Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1412 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocityPSD

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1413
Ansys.ACT.Automation.Mechanical.Results.DeformationResults 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; }

DirectionalVelocityRS
Defines a DirectionalVelocityRS.

Declaration Syntax
public class DirectionalVelocityRS : DeformationResult

Table 408: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1414 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocityRS

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1419) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1415
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1419) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1416 of ANSYS, Inc. and its subsidiaries and affiliates.
 DirectionalVelocityRS

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property NormalOrientation (p. 1419) Gets or sets the NormalOrientation.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1417
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1418 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalAcceleration

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

TotalAcceleration
Defines a TotalAcceleration.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1419
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Declaration Syntax
public class TotalAcceleration : DeformationResult

Table 409: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1420 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalAcceleration

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1424) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1424) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1421
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1422 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalAcceleration

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1423
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DataModelObjectCategory
Gets the current DataModelObject's category.

Declaration Syntax
public DataModelObjectCategory DataModelObjectCategory { get; }

InternalObject
Gets the internal object. For advanced usage only.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1424 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalDeformation

Declaration Syntax
public IDSResultAuto InternalObject { get; }

TotalDeformation
Defines a TotalDeformation.

Declaration Syntax
public class TotalDeformation : DeformationResult

Table 410: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1425
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1430) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1426 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalDeformation

Property InternalObject (p. 1430) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1427
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1428 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalDeformation

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1429
Ansys.ACT.Automation.Mechanical.Results.DeformationResults 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; }

TotalVelocity
Defines a TotalVelocity.

Declaration Syntax
public class TotalVelocity : DeformationResult

Table 411: Members

Property AccelerationInG (p. 1377) Gets or sets the AccelerationInG.

(Inherited from DeformationResult (p. 1373).)

Property AllowPhaseSweep (p. 1378) Gets or sets the AllowPhaseSweep.

(Inherited from DeformationResult (p. 1373).)

Property Amplitude (p. 1378) Gets or sets the Amplitude.

(Inherited from DeformationResult (p. 1373).)

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1430 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalVelocity

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property CyclicMode (p. 1378) Gets or sets the CyclicMode.

(Inherited from DeformationResult (p. 1373).)

Property CyclicPhase (p. 1378) Gets or sets the CyclicPhase.

(Inherited from DeformationResult (p. 1373).)

Property DampedFrequency (p. 1378) Gets the DampedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property DataModelObjectCategory (p. 1435) Gets the current DataModelObject's
category.
Property DeformationType (p. 1379) Gets or sets the DeformationType.

(Inherited from DeformationResult (p. 1373).)

Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property EnvironmentSelection (p. 1379) Gets or sets the EnvironmentSelection.

(Inherited from DeformationResult (p. 1373).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property Frequency (p. 1379) Gets or sets the Frequency.

(Inherited from DeformationResult (p. 1373).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1431
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property HarmonicIndex (p. 1379) Gets or sets the HarmonicIndex.

(Inherited from DeformationResult (p. 1373).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1435) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property IterationStep (p. 1379) Gets or sets the IterationStep.

(Inherited from DeformationResult (p. 1373).)

Property LoadMultiplier (p. 1380) Gets the LoadMultiplier.

(Inherited from DeformationResult (p. 1373).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1432 of ANSYS, Inc. and its subsidiaries and affiliates.
 TotalVelocity

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property LogarithmicDecrement (p. 1380) Gets the LogarithmicDecrement.

(Inherited from DeformationResult (p. 1373).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property ModalDampingRatio (p. 1380) Gets the ModalDampingRatio.

(Inherited from DeformationResult (p. 1373).)

Property Mode (p. 1380) Gets or sets the Mode.

(Inherited from DeformationResult (p. 1373).)

Property PhaseIncrement (p. 1380) Gets or sets the PhaseIncrement.

(Inherited from DeformationResult (p. 1373).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property Probability (p. 1380) Gets the Probability.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1433
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

(Inherited from DeformationResult (p. 1373).)

Property Reference (p. 1381) Gets the Reference.

(Inherited from DeformationResult (p. 1373).)

Property ReportedFrequency (p. 1381) Gets the ReportedFrequency.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactor (p. 1381) Gets or sets the ScaleFactor.

(Inherited from DeformationResult (p. 1373).)

Property ScaleFactorValue (p. 1381) Gets or sets the ScaleFactorValue.

(Inherited from DeformationResult (p. 1373).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Stability (p. 1381) Gets the Stability.

(Inherited from DeformationResult (p. 1373).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property SweepingPhase (p. 1381) Gets or sets the SweepingPhase.

(Inherited from DeformationResult (p. 1373).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1434 of ANSYS, Inc. and its subsidiaries and affiliates.
 VectorDeformation

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

VectorDeformation
Defines a VectorDeformation.

Declaration Syntax
public class VectorDeformation : Result

Table 412: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1435
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DataModelObjectCategory (p. 1439) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1439) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1436 of ANSYS, Inc. and its subsidiaries and affiliates.
 VectorDeformation

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1437
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1438 of ANSYS, Inc. and its subsidiaries and affiliates.
 VectorDeformation

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1439
 Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1440 of ANSYS, Inc. and its subsidiaries and affiliates.
Ansys.ACT.Automation.Mechanical.Results.DamageResults
Namespace
Declaration Syntax
namespace Ansys.ACT.Automation.Mechanical.Results.DamageResults

Table 413: Members

DamageResult (p. 1441) Defines a DamageResult.

DamageStatus (p. 1446)
EnergyDissipatedPerUnitVolume (p. 1450)
FiberCompressiveDamageVariable (p. 1453)
FiberCompressiveFailureCriterion (p. 1457)
FiberTensileDamageVariable (p. 1461)
FiberTensileFailureCriterion (p. 1465)
MatrixCompressiveDamageVariable (p. 1469)
MatrixCompressiveFailureCriterion (p. 1473)
MatrixTensileDamageVariable (p. 1477)
MatrixTensileFailureCriterion (p. 1481)
MaximumFailureCriteria (p. 1485)
MullinsDamageVariable (p. 1489)
MullinsMaximumPreviousStrainEnergy (p. 1493) Defines a
MullinsMaximumPreviousStrainEnergy.
ShearDamageVariable (p. 1497)
Defines a DamageStatus.
Defines a EnergyDissipatedPerUnitVolume.
Defines a
FiberCompressiveDamageVariable.
Defines a FiberCompressiveFailureCriterion.
Defines a FiberTensileDamageVariable.
Defines a FiberTensileFailureCriterion.
Defines a
MatrixCompressiveDamageVariable.
Defines a
MatrixCompressiveFailureCriterion.
Defines a MatrixTensileDamageVariable.
Defines a MatrixTensileFailureCriterion.
Defines a MaximumFailureCriteria.
Defines a MullinsDamageVariable.
Defines a ShearDamageVariable.

DamageResult
Defines a DamageResult.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1441
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public abstract class DamageResult : Result

Table 414: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.
Property DataModelObjectCategory (p. 1445) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1442 of ANSYS, Inc. and its subsidiaries and affiliates.
 DamageResult

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1445) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1443
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.
Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1444 of ANSYS, Inc. and its subsidiaries and affiliates.
 DamageResult

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

DamageResultType
Gets the DamageResultType.

Declaration Syntax
public DamageResultType DamageResultType { 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 IDSResultAuto InternalObject { get; }

Mode
Gets or sets the Mode.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1445
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public uint Mode { set;get; }

DamageStatus
Defines a DamageStatus.

Declaration Syntax
public class DamageStatus : DamageResult

Table 415: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1449) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1446 of ANSYS, Inc. and its subsidiaries and affiliates.
 DamageStatus

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1449) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1447
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1448 of ANSYS, Inc. and its subsidiaries and affiliates.
 DamageStatus

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1449
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

EnergyDissipatedPerUnitVolume
Defines a EnergyDissipatedPerUnitVolume.

Declaration Syntax
public class EnergyDissipatedPerUnitVolume : DamageResult

Table 416: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1453) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1450 of ANSYS, Inc. and its subsidiaries and affiliates.
 EnergyDissipatedPerUnitVolume

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1453) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1451
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1452 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberCompressiveDamageVariable

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

FiberCompressiveDamageVariable
Defines a FiberCompressiveDamageVariable.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1453
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class FiberCompressiveDamageVariable : DamageResult

Table 417: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1457) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1454 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberCompressiveDamageVariable

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1457) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1455
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1456 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberCompressiveFailureCriterion

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

FiberCompressiveFailureCriterion
Defines a FiberCompressiveFailureCriterion.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1457
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class FiberCompressiveFailureCriterion : DamageResult

Table 418: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1461) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1458 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberCompressiveFailureCriterion

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1461) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1459
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1460 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberTensileDamageVariable

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

FiberTensileDamageVariable
Defines a FiberTensileDamageVariable.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1461
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class FiberTensileDamageVariable : DamageResult

Table 419: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1465) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1462 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberTensileDamageVariable

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1465) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1463
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1464 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberTensileFailureCriterion

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

FiberTensileFailureCriterion
Defines a FiberTensileFailureCriterion.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1465
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class FiberTensileFailureCriterion : DamageResult

Table 420: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1469) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1466 of ANSYS, Inc. and its subsidiaries and affiliates.
 FiberTensileFailureCriterion

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1469) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1467
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1468 of ANSYS, Inc. and its subsidiaries and affiliates.
 MatrixCompressiveDamageVariable

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

MatrixCompressiveDamageVariable
Defines a MatrixCompressiveDamageVariable.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1469
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class MatrixCompressiveDamageVariable : DamageResult

Table 421: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1473) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1470 of ANSYS, Inc. and its subsidiaries and affiliates.
 MatrixCompressiveDamageVariable

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1473) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1471
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1472 of ANSYS, Inc. and its subsidiaries and affiliates.
 MatrixCompressiveFailureCriterion

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

MatrixCompressiveFailureCriterion
Defines a MatrixCompressiveFailureCriterion.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1473
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class MatrixCompressiveFailureCriterion : DamageResult

Table 422: Members

Property Average (p. 1176) Gets the Average.

(Inherited from Result (p. 1174).)

Property By (p. 1176) Gets or sets the By.

(Inherited from Result (p. 1174).)

Property CalculateTimeHistory (p. 1176) Gets or sets the CalculateTimeHistory.

(Inherited from Result (p. 1174).)

Property Children (p. 1176) Gets the list of children.

(Inherited from Result (p. 1174).)

Property CombinationNumber (p. 1177) Gets or sets the Combination Number for
a Solution Combination result.

(Inherited from Result (p. 1174).)

Property Comments (p. 1177) Gets the list of associated comments.

(Inherited from Result (p. 1174).)

Property CoordinateSystem (p. 1177) 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. 1174).)

Property DamageResultType (p. 1445) Gets the DamageResultType.

(Inherited from DamageResult (p. 1441).)

Property DataModelObjectCategory (p. 1477) Gets the current DataModelObject's
category.
Property DisplayOption (p. 1177) Gets or sets the DisplayOption.

(Inherited from Result (p. 1174).)

Property DisplayTime (p. 1178) Gets or sets the DisplayTime.

(Inherited from Result (p. 1174).)

Property DpfEvaluation (p. 1178) Gets or sets the DpfEvaluation.

(Inherited from Result (p. 1174).)

Property Figures (p. 1178) Gets the list of associated figures.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1474 of ANSYS, Inc. and its subsidiaries and affiliates.
 MatrixCompressiveFailureCriterion

Property GlobalIDs (p. 1178) Gets or sets the GlobalIDs.

(Inherited from Result (p. 1174).)

Property GraphControlsXAxis (p. 1178) Gets or sets the GraphControlsXAxis.

(Inherited from Result (p. 1174).)

Property Identifier (p. 1178) Gets or sets the Identifier.

(Inherited from Result (p. 1174).)

Property Images (p. 1179) Gets the list of associated images.

(Inherited from Result (p. 1174).)

Property InternalObject (p. 1477) Gets the internal object. For advanced
usage only.
Property IsSolved (p. 1179) Gets the IsSolved.

(Inherited from Result (p. 1174).)

Property ItemType (p. 1179) Gets or sets the ItemType.

(Inherited from Result (p. 1174).)

Property IterationNumber (p. 1179) Gets the IterationNumber.

(Inherited from Result (p. 1174).)

Property LoadStep (p. 1179) Gets the LoadStep.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMaximumValues (p. 1180)Get the Load Step for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMaximumOfMinimumValues (p. 1180)Get the Load Step for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMaximumValues (p. 1180)Get the Load Step for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property LoadStepForMinimumOfMinimumValues (p. 1180)Get the Load Step for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

Property LoadStepNumber (p. 1180) Gets or sets the LoadStepNumber.

(Inherited from Result (p. 1174).)

Property Location (p. 1180) Gets or sets the Location.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1475
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Property Maximum (p. 1181) Gets the Maximum.

(Inherited from Result (p. 1174).)

Property MaximumOccursOn (p. 1181) Gets the MaximumOccursOn.

(Inherited from Result (p. 1174).)

Property MaximumOfMaximumOverTime (p. 1181) Gets the MaximumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MaximumOfMinimumOverTime (p. 1181) Gets the MaximumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Minimum (p. 1181) Gets the Minimum.

(Inherited from Result (p. 1174).)

Property MinimumOccursOn (p. 1181) Gets the MinimumOccursOn.

(Inherited from Result (p. 1174).)

Property MinimumOfMaximumOverTime (p. 1182) Gets the MinimumOfMaximumOverTime.

(Inherited from Result (p. 1174).)

Property MinimumOfMinimumOverTime (p. 1182) Gets the MinimumOfMinimumOverTime.

(Inherited from Result (p. 1174).)

Property Mode (p. 1445) Gets or sets the Mode.

(Inherited from DamageResult (p. 1441).)

Property PlotData (p. 1182) Gets the result table.

(Inherited from Result (p. 1174).)

Property ScopingMethod (p. 1182) Gets or sets the ScopingMethod.

(Inherited from Result (p. 1174).)

Property SetNumber (p. 1182) Gets or sets the Set Number.

(Inherited from Result (p. 1174).)

Property SolutionCombinationDriver (p. 1182) Gets or sets the
SolutionCombinationDriver.

(Inherited from Result (p. 1174).)

Property SolverComponentIDs (p. 1183) Gets or sets the SolverComponentIDs.

(Inherited from Result (p. 1174).)

Property Substep (p. 1183) Gets the Substep.

(Inherited from Result (p. 1174).)

Property Suppressed (p. 1183) Gets or sets the Suppressed.

(Inherited from Result (p. 1174).)

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1476 of ANSYS, Inc. and its subsidiaries and affiliates.
 MatrixTensileDamageVariable

Property Surface (p. 1183) No details are provided for this entry.

(Inherited from Result (p. 1174).)

Property Time (p. 1183) Gets the Time.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMaximumValues (p. 1183) Get the Time for the maximum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMaximumOfMinimumValues (p. 1184) Get the Time for the maximum of
minimum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMaximumValues (p. 1184) Get the Time for the minimum of
maximum values.

(Inherited from Result (p. 1174).)

Property TimeForMinimumOfMinimumValues (p. 1184) Get the Time for the minimum of
minimum values.

(Inherited from Result (p. 1174).)

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; }

MatrixTensileDamageVariable
Defines a MatrixTensileDamageVariable.

Release 2022 R2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1477
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace

Declaration Syntax
public class MatrixTensileDamageVariable : DamageResult

Table 423: Members

Property Average (p. 1176) Gets the Average.